models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaConceptIdentifier.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP Policy Models
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2020-2021 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.models.tosca.authorative.concepts;
  23
  24 import lombok.Data;
  25 import lombok.NoArgsConstructor;
  26 import lombok.NonNull;
  27 import org.apache.commons.lang3.ObjectUtils;
  28 import org.onap.policy.common.parameters.BeanValidationResult;
  29 import org.onap.policy.common.parameters.ValidationResult;
  30
  31 /**
  32  * Identifies a concept. Both the name and version must be non-null.
  33  */
  34 @Data
  35 @NoArgsConstructor
  36 public class ToscaConceptIdentifier implements Comparable<ToscaConceptIdentifier> {
  37
  38     @NonNull
  39     private String name;
  40
  41     @NonNull
  42     private String version;
  43
  44
  45     public ToscaConceptIdentifier(@NonNull String name, @NonNull String version) {
  46         this.name = name;
  47         this.version = version;
  48     }
  49
  50     public ToscaConceptIdentifier(ToscaConceptIdentifier source) {
  51         this.name = source.name;
  52         this.version = source.version;
  53     }
  54
  55     /**
  56      * Validates that appropriate fields are populated for an incoming call to the PAP REST API.
  57      *
  58      * @return the validation result
  59      */
  60     public ValidationResult validatePapRest() {
  61         BeanValidationResult result = new BeanValidationResult("group", this);
  62
  63         result.validateNotNull("name", name);
  64         result.validateNotNull("version", version);
  65
  66         return result;
  67     }
  68
  69     @Override
  70     public int compareTo(ToscaConceptIdentifier other) {
  71         if (this == other) {
  72             return 0;
  73         }
  74
  75         if (other == null) {
  76             return 1;
  77         }
  78
  79         int result = ObjectUtils.compare(getName(), other.getName());
  80         if (result != 0) {
  81             return result;
  82         }
  83
  84         return ObjectUtils.compare(getVersion(), other.getVersion());
  85     }
  86
  87     @Override
  88     public String toString() {
  89         return this.name + " " + this.version;
  90     }
  91 }