models-base/src/main/java/org/onap/policy/models/base/PfNameVersion.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-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  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.models.base;
  22
  23 import org.apache.commons.lang3.ObjectUtils;
  24 import org.onap.policy.common.utils.validation.Version;
  25
  26 /**
  27  * An interface that forces a POJO to have getName() and getVersion() methods.
  28  *
  29  * @author Liam Fallon (liam.fallon@est.tech)
  30  */
  31 public interface PfNameVersion {
  32     public String getName();
  33
  34     public void setName(final String name);
  35
  36     public String getVersion();
  37
  38     public void setVersion(final String version);
  39
  40     /**
  41      * Get the defined name for a concept, return null if no name is defined.
  42      *
  43      * @return the defined name
  44      */
  45     public default String getDefinedName() {
  46         return getName();
  47     }
  48
  49     /**
  50      * Get the defined version for a concept, return null if no version is defined.
  51      *
  52      * @return the defined version
  53      */
  54     public default String getDefinedVersion() {
  55         return getVersion();
  56     }
  57
  58     /**
  59      * Compare two name version implementation objects.
  60      *
  61      * @param left the left name/version implementation
  62      * @param right the right name/version implementation
  63      * @return the comparison resilt
  64      */
  65     public default int compareNameVersion(final PfNameVersion left, final PfNameVersion right) {
  66         if (left == null && right == null) {
  67             return 0;
  68         }
  69
  70         if (left == null) {
  71             return 1;
  72         }
  73
  74         if (right == null) {
  75             return -1;
  76         }
  77
  78         int result = ObjectUtils.compare(left.getName(), right.getName());
  79         if (result != 0) {
  80             return result;
  81         }
  82
  83         if (left.getVersion() == null && right.getVersion() == null) {
  84             return 0;
  85         }
  86
  87         if (left.getVersion() == null) {
  88             return 1;
  89         }
  90
  91         if (right.getVersion() == null) {
  92             return -1;
  93         }
  94         return new Version(left.getVersion()).compareTo(new Version(right.getVersion()));
  95     }
  96 }