common-be/src/main/java/org/openecomp/sdc/be/datatypes/enums/NodeFilterConstraintType.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  *
  16  *  SPDX-License-Identifier: Apache-2.0
  17  *  ============LICENSE_END=========================================================
  18  */
  19 package org.openecomp.sdc.be.datatypes.enums;
  20
  21 import java.util.Optional;
  22 import lombok.AllArgsConstructor;
  23 import lombok.Getter;
  24
  25 /**
  26  * Represents the type of a node filter constraint.
  27  */
  28 @Getter
  29 @AllArgsConstructor
  30 public enum NodeFilterConstraintType {
  31
  32     PROPERTIES(NodeFilterConstraintType.PROPERTIES_PARAM_NAME),
  33     CAPABILITIES(NodeFilterConstraintType.CAPABILITIES_PARAM_NAME);
  34
  35     // Those values are needed as constants for Swagger allowedValues param
  36     public static final String PROPERTIES_PARAM_NAME = "properties";
  37     public static final String CAPABILITIES_PARAM_NAME = "capabilities";
  38     private final String type;
  39
  40     /**
  41      * Parse a String to the related {@link NodeFilterConstraintType}.
  42      *
  43      * @param type the {@link NodeFilterConstraintType} type
  44      * @return The {@link NodeFilterConstraintType} representing the given type.
  45      */
  46     public static Optional<NodeFilterConstraintType> parse(final String type) {
  47         for (final NodeFilterConstraintType nodeFilterConstraintType : values()) {
  48             if (nodeFilterConstraintType.getType().equals(type)) {
  49                 return Optional.of(nodeFilterConstraintType);
  50             }
  51         }
  52         return Optional.empty();
  53     }
  54 }