PolicyEngineAPI/src/main/java/org/onap/policy/api/RuleProvider.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 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 BLACKLIST YAML
  46          */
  47         GUARD_BL_YAML("GUARD_BL_YAML"),
  48         /**
  49          * Indicates Guard BLACKLIST YAML
  50          */
  51         RAINY_DAY("Rainy_Day")
  52         ;
  53
  54         private String name;
  55
  56         private RuleProvider(String typeName){
  57                 this.name = typeName;
  58         }
  59
  60         /**
  61          * Returns the <code>String</code> format of Type for this <code>AttributeType</code>
  62          * @return the <code>String</code> of the Type for this <code>AttributeType</code>
  63          */
  64         @Override
  65         public String toString() {
  66                 return this.name;
  67         }
  68
  69         @JsonCreator
  70     public static RuleProvider create (String value) {
  71         for(RuleProvider type: values()){
  72             if(type.toString().equals(value) || type.equals(RuleProvider.valueOf(value))){
  73                 return type;
  74             }
  75         }
  76         throw new IllegalArgumentException();
  77     }
  78 }