PolicyEngineAPI/src/main/java/org/onap/policy/api/AttributeType.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 AttributeType {
  32         /**
  33          * Indicates Attributes required to Match the Policy.
  34          */
  35         MATCHING("matching"),
  36         /**
  37          * Indicates Attributes required to create DRL based Rules.
  38          */
  39         RULE("rule"),
  40         /**
  41          * Indicates Attributes required to create MicroService policy.
  42          */
  43         MICROSERVICE("microService"),
  44         /**
  45          * Indicates Attributes required to create Optimization policy.
  46          */
  47         OPTIMIZATION("optimization"),
  48         /**
  49          * Indicates Attributes required to create settings for Decision Policy.
  50          */
  51         SETTINGS("settings"),
  52         /**
  53          * Indicates Attributes required to create dictionary fields for creating Dictionary Items
  54          */
  55         DICTIONARY("dictionary")
  56         ;
  57
  58
  59         private String name;
  60
  61         private AttributeType(String typeName){
  62                 this.name = typeName;
  63         }
  64
  65         /**
  66          * Returns the <code>String</code> format of Type for this <code>AttributeType</code>
  67          * @return the <code>String</code> of the Type for this <code>AttributeType</code>
  68          */
  69         @Override
  70         public String toString() {
  71                 return this.name;
  72         }
  73
  74         @JsonCreator
  75     public static AttributeType create (String value) {
  76         for(AttributeType type: values()){
  77             if(type.toString().equalsIgnoreCase(value)){
  78                 return type;
  79             }
  80         }
  81         throw new IllegalArgumentException();
  82     }
  83 }