Initial OpenECOMP policy/engine commit
[policy/engine.git] / PolicyEngineAPI / src / main / java / org / openecomp / policy / api / PolicyType.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.openecomp.policy.api;
22
23 /**
24  * Enumeration of the Policy Return Types that can be returned as part of a
25  * {@link org.openecomp.policy.api.PolicyConfig}.
26  * 
27  * @version 0.2
28  */
29 public enum PolicyType {
30         /**
31          * Indicates the response is Properties type
32          */
33         PROPERTIES("Properties"),
34         /**
35          * Indicates the response is JSON type
36          */
37         JSON("json"),
38         /**
39          * Indicates the response is XML type
40          */
41         XML("xml"),
42         /**
43          * Indicates the response is Other type
44          */
45         OTHER("other")
46         ;
47         
48         private String name; 
49         
50         private PolicyType(String typeName) {
51                 this.name = typeName;
52         }
53         
54         /**
55          * Returns the <code>String</code> format of Type for this <code>PolicyType</code>
56          * @return the <code>String</code> of the Type for this <code>PolicyType</code>
57          */
58         public String toString() {
59                 return this.name;
60         }
61 }