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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.models.base;
  23
  24 import lombok.AccessLevel;
  25 import lombok.NoArgsConstructor;
  26 import lombok.NonNull;
  27
  28 /**
  29  * The key uniquely identifies every entity in the system. This class is an abstract class to give a common parent for
  30  * all key types in the system.
  31  */
  32 @NoArgsConstructor(access = AccessLevel.PROTECTED)
  33 public abstract class PfKey extends PfConcept {
  34     private static final long serialVersionUID = 6281159885962014041L;
  35
  36     /** Regular expression to specify the structure of key names. */
  37     public static final String NAME_REGEXP = "^[A-Za-z0-9\\-_\\.]+$";
  38
  39     /** Regular expression to specify the structure of key versions. */
  40     public static final String VERSION_REGEXP = "^(\\d+.){2}\\d+$";
  41
  42     /** Regular expression to specify the structure of key IDs. */
  43     public static final String KEY_ID_REGEXP = "^[A-Za-z0-9\\-_\\.]+:(\\d+.){2}\\d+$";
  44
  45     /** Specifies the value for names in NULL keys. */
  46     public static final String NULL_KEY_NAME = "NULL";
  47
  48     /** Specifies the value for versions in NULL keys. */
  49     public static final String NULL_KEY_VERSION = "0.0.0";
  50
  51     /**
  52      * This enumeration is returned on key compatibility checks.
  53      */
  54     public enum Compatibility {
  55         /** The keys have different names. */
  56         DIFFERENT,
  57         /**
  58          * The name of the key matches but the Major version number of the keys is different (x in x.y.z do not match).
  59          */
  60         MAJOR,
  61         /**
  62          * The name of the key matches but the Minor version number of the keys is different (y in x.y.z do not match).
  63          */
  64         MINOR,
  65         /**
  66          * The name of the key matches but the Patch version number of the keys is different (z in x.y.z do not match).
  67          */
  68         PATCH,
  69         /** The keys match completely. */
  70         IDENTICAL
  71     }
  72
  73     /**
  74      * Copy constructor.
  75      *
  76      * @param copyConcept the concept to copy from
  77      */
  78     protected PfKey(final PfKey copyConcept) {
  79         super(copyConcept);
  80     }
  81
  82     @Override
  83     public abstract String getId();
  84
  85     /**
  86      * Return the result of a compatibility check of two keys.
  87      *
  88      * @param otherKey the key to check compatibility against
  89      * @return the compatibility result of the check
  90      */
  91     public abstract Compatibility getCompatibility(@NonNull PfKey otherKey);
  92
  93     /**
  94      * Check if two keys are compatible, that is the keys are IDENTICAL or have only MINOR, PATCH differences.
  95      *
  96      * @param otherKey the key to check compatibility against
  97      * @return true, if the keys are compatible
  98      */
  99     public abstract boolean isCompatible(@NonNull PfKey otherKey);
 100
 101     /**
 102      * Check if this key is a newer version than the other key.
 103      *
 104      * @param otherKey the key to check against
 105      * @return true, if this key is newer than the other key
 106      */
 107     public abstract boolean isNewerThan(@NonNull PfKey otherKey);
 108
 109     /**
 110      * Check if a key equals its null key.
 111      *
 112      * @return true, if the key is a null key
 113      */
 114     public abstract boolean isNullKey();
 115
 116     /**
 117      * Get the major version of a key.
 118      *
 119      * @return the major version of a key
 120      */
 121     public abstract int getMajorVersion();
 122
 123     /**
 124      * Get the minor version of a key.
 125      *
 126      * @return the minor version of a key
 127      */
 128     public abstract int getMinorVersion();
 129
 130     /**
 131      * Get the patch version of a key.
 132      *
 133      * @return the patch version of a key
 134      */
 135     public abstract int getPatchVersion();
 136 }