PolicyEngineAPI/src/main/java/org/onap/policy/api/DeletePolicyCondition.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 Delete Condition that is used as a part of
  27  * {@link org.onap.policy.api.DeletePolicyParameters}.
  28  *
  29  * @version 0.1
  30  */
  31 public enum DeletePolicyCondition {
  32
  33     /**
  34      * Indicates a condition to only delete the current version of the policy.
  35      */
  36     ONE("Current Version"),
  37
  38     /**
  39      * Indicates a condition to delete all versions of the policy.
  40      */
  41     ALL("All Versions");
  42
  43     private final String name;
  44
  45     private DeletePolicyCondition(final String name) {
  46         this.name = name;
  47     }
  48
  49     /**
  50      * Returns the <code>String</code> format of delete condition for this
  51      * Policy
  52      *
  53      * @return the <code>String</code> of the delete condition for this Policy
  54      */
  55     @Override
  56     public String toString() {
  57         return this.name;
  58     }
  59
  60     @JsonCreator
  61     public static DeletePolicyCondition create(final String value) {
  62         for (final DeletePolicyCondition type : values()) {
  63             if (type.toString().equalsIgnoreCase(value) || type.name().equalsIgnoreCase(value)) {
  64                 return type;
  65             }
  66         }
  67         throw new IllegalArgumentException("Invalid value: " + value);
  68     }
  69 }