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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * PolicyEngineAPI
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 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 the Attribute Types that is used as a part of
  27  * {@link org.onap.policy.api.PolicyParameters}.
  28  *
  29  * @version 0.1
  30  */
  31 public enum RuleProvider {
  32     /**
  33      * Indicates User will be defining the Rule information.
  34      */
  35     CUSTOM("Custom"),
  36     /**
  37      * Indicates AAF will be providing the Rule information.
  38      */
  39     AAF("AAF"),
  40     /**
  41      * Indicates Guard YAML will be providing the Rule information.
  42      */
  43     GUARD_YAML("GUARD_YAML"),
  44     /**
  45      * Indicates Guard MIN / MAX will be providing the Rule information.
  46      */
  47     GUARD_MIN_MAX("GUARD_MIN_MAX"),
  48     /**
  49      * Indicates Guard BLACKLIST YAML.
  50      */
  51     GUARD_BL_YAML("GUARD_BL_YAML"),
  52     /**
  53      * Indicates Rainy Day Decision Policy.
  54      */
  55     RAINY_DAY("Rainy_Day"),
  56     /**
  57      * Indicates Raw.
  58      */
  59     RAW("Raw");
  60
  61     private final String name;
  62
  63     private RuleProvider(final String typeName) {
  64         this.name = typeName;
  65     }
  66
  67     /**
  68      * Returns the <code>String</code> format of Type for this
  69      * <code>AttributeType</code>
  70      *
  71      * @return the <code>String</code> of the Type for this
  72      *         <code>AttributeType</code>
  73      */
  74     @Override
  75     public String toString() {
  76         return this.name;
  77     }
  78
  79     @JsonCreator
  80     public static RuleProvider create(final String value) {
  81         for (final RuleProvider type : values()) {
  82             if (type.toString().equalsIgnoreCase(value) || type.name().equalsIgnoreCase(value)) {
  83                 return type;
  84             }
  85         }
  86         throw new IllegalArgumentException("Invalid value: " + value);
  87     }
  88 }