0a4621902fb0b4203a94671e046206859251aea7
[policy/engine.git] / 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 settings for Decision Policy.
46          */
47         SETTINGS("settings"),
48         /**
49          * Indicates Attributes required to create dictionary fields for creating Dictionary Items
50          */
51         DICTIONARY("dictionary")
52         ;
53         
54         
55         private String name;
56         
57         private AttributeType(String typeName){
58                 this.name = typeName;
59         }
60         
61         /**
62          * Returns the <code>String</code> format of Type for this <code>AttributeType</code>
63          * @return the <code>String</code> of the Type for this <code>AttributeType</code>
64          */
65         @Override
66         public String toString() {
67                 return this.name;
68         }
69         
70         @JsonCreator
71     public static AttributeType create (String value) {
72         for(AttributeType type: values()){
73             if(type.toString().equalsIgnoreCase(value)){
74                 return type;
75             }
76         }
77         throw new IllegalArgumentException();
78     }
79 }