PolicyEngineAPI/src/main/java/org/onap/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.onap.policy.api;
  22
  23 import com.fasterxml.jackson.annotation.JsonCreator;
  24
  25 /**
  26  * Enumeration of the Policy Return Types that can be returned as part of a
  27  * {@link org.onap.policy.api.PolicyConfig}.
  28  *
  29  * @version 0.2
  30  */
  31 public enum PolicyType {
  32     /**
  33      * Indicates the response is Properties type
  34      */
  35     PROPERTIES("Properties"),
  36     /**
  37      * Indicates the response is JSON type
  38      */
  39     JSON("json"),
  40     /**
  41      * Indicates the response is XML type
  42      */
  43     XML("xml"),
  44     /**
  45      * Indicates the response is Other type
  46      */
  47     OTHER("other");
  48
  49     private final String name;
  50
  51     private PolicyType(final String typeName) {
  52         this.name = typeName;
  53     }
  54
  55     /**
  56      * Returns the <code>String</code> format of Type for this
  57      * <code>PolicyType</code>
  58      *
  59      * @return the <code>String</code> of the Type for this
  60      *         <code>PolicyType</code>
  61      */
  62     @Override
  63     public String toString() {
  64         return this.name;
  65     }
  66
  67     @JsonCreator
  68     public static PolicyType create(final String value) {
  69         for (final PolicyType type : values()) {
  70             if (type.toString().equalsIgnoreCase(value) || type.name().equalsIgnoreCase(value)) {
  71                 return type;
  72             }
  73         }
  74         throw new IllegalArgumentException("Invalid value: " + value);
  75     }
  76 }