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     private final String name;
  42
  43     private PolicyConfigStatus(final String name) {
  44         this.name = name;
  45     }
  46
  47     /**
  48      * Get the <code>PolicyConfigStatus</code> based on <code>String</code>
  49      * representation of <code>PolicyConfig</code>
  50      *
  51      * @param configStatus
  52      *            the <code>String</code> Configuration Status
  53      * @return the <code>PolicyConfigResponse</code> with the name matching
  54      *         <code>CONFIG_RETRIEVED</code> or <code>CONFIG_NOT_FOUND</code> if
  55      *         no match is found
  56      */
  57     public static PolicyConfigStatus getStatus(final String configStatus) {
  58         if (CONFIG_RETRIEVED.name.equalsIgnoreCase(configStatus)) {
  59             return CONFIG_RETRIEVED;
  60         }
  61         return CONFIG_NOT_FOUND;
  62     }
  63
  64     /**
  65      * Returns the <code>String</code> name for this
  66      * <code>PolicyConfigStatus</code>
  67      *
  68      * @return the <code>String</code> name for this
  69      *         <code>PolicyConfigStatus</code>
  70      */
  71     @Override
  72     public String toString() {
  73         return this.name;
  74     }
  75
  76     @JsonCreator
  77     public static PolicyConfigStatus create(final String value) {
  78         for (final PolicyConfigStatus type : values()) {
  79             if (type.toString().equalsIgnoreCase(value) || type.name().equalsIgnoreCase(value)) {
  80                 return type;
  81             }
  82         }
  83         throw new IllegalArgumentException("Invalid value: " + value);
  84     }
  85 }