PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyConfigStatus.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * PolicyEngineAPI
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.api;
  22
  23 import com.fasterxml.jackson.annotation.JsonCreator;
  24
  25 /**
  26  * Enumeration of PolicyConfigStatus that can be returned as a part of
  27  * {@link org.onap.policy.api.PolicyConfig}.
  28  *
  29  * @version 0.1
  30  */
  31 public enum PolicyConfigStatus {
  32         /**
  33          * Indicates that the Configuration has been successfully retrieved.
  34          */
  35         CONFIG_RETRIEVED("retrieved"),
  36         /**
  37          * Indicates that there is no Configuration Retrieved from PolicyConfig.
  38          */
  39         CONFIG_NOT_FOUND("not_found"),
  40         ;
  41
  42         private String name;
  43         private PolicyConfigStatus(String name){
  44                 this.name = name;
  45         }
  46
  47         /**
  48          * Get the <code>PolicyConfigStatus</code> based on <code>String</code> representation of <code>PolicyConfig</code>
  49          *
  50          * @param configStatus the <code>String</code> Configuration Status
  51          * @return the <code>PolicyConfigResponse</code> with the name matching <code>CONFIG_RETRIEVED</code> or <code>CONFIG_NOT_FOUND</code>
  52          * if no match is found
  53          */
  54         public static PolicyConfigStatus getStatus(String configStatus) {
  55                 if(configStatus.equalsIgnoreCase("retrieved")) {
  56                         return CONFIG_RETRIEVED;
  57                 }else {
  58                         return CONFIG_NOT_FOUND;
  59                 }
  60         }
  61
  62         /**
  63          * Returns the <code>String</code> name for this <code>PolicyConfigStatus</code>
  64          *
  65          * @return the <code>String</code> name for this <code>PolicyConfigStatus</code>
  66          */
  67         public String toString(){
  68                 return this.name;
  69         }
  70         @JsonCreator
  71     public static PolicyConfigStatus create (String value) {
  72         for(PolicyConfigStatus type: values()){
  73             if(type.toString().equals(value) || type.equals(PolicyConfigStatus.valueOf(value))){
  74                 return type;
  75             }
  76         }
  77         throw new IllegalArgumentException();
  78     }
  79 }