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 import org.onap.policy.models.base.PfConceptKey;
  31 import org.onap.policy.models.base.PfKey;
  32
  33 /**
  34  * Identifies a concept. Both the name and version must be non-null.
  35  */
  36 @Data
  37 @NoArgsConstructor
  38 public class ToscaConceptIdentifier implements Comparable<ToscaConceptIdentifier> {
  39
  40     @NonNull
  41     private String name;
  42
  43     @NonNull
  44     private String version;
  45
  46
  47     public ToscaConceptIdentifier(@NonNull String name, @NonNull String version) {
  48         this.name = name;
  49         this.version = version;
  50     }
  51
  52     public ToscaConceptIdentifier(@NonNull PfKey key) {
  53         this.name = key.getName();
  54         this.version = key.getVersion();
  55     }
  56
  57     public ToscaConceptIdentifier(ToscaConceptIdentifier source) {
  58         this.name = source.name;
  59         this.version = source.version;
  60     }
  61
  62     /**
  63      * Validates that appropriate fields are populated for an incoming call to the PAP REST API.
  64      *
  65      * @return the validation result
  66      */
  67     public ValidationResult validatePapRest() {
  68         BeanValidationResult result = new BeanValidationResult("group", this);
  69
  70         result.validateNotNull("name", name);
  71         result.validateNotNull("version", version);
  72
  73         return result;
  74     }
  75
  76     /**
  77      * Create a PfConcceptKey from the TOSCA identifier.
  78      *
  79      * @return the key
  80      */
  81     public PfConceptKey asConceptKey() {
  82         return new PfConceptKey(name, version);
  83     }
  84
  85     @Override
  86     public int compareTo(ToscaConceptIdentifier other) {
  87         if (this == other) {
  88             return 0;
  89         }
  90
  91         if (other == null) {
  92             return 1;
  93         }
  94
  95         int result = ObjectUtils.compare(getName(), other.getName());
  96         if (result != 0) {
  97             return result;
  98         }
  99
 100         return ObjectUtils.compare(getVersion(), other.getVersion());
 101     }
 102
 103     @Override
 104     public String toString() {
 105         return this.name + " " + this.version;
 106     }
 107 }