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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019-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 java.io.Serializable;
  25 import java.util.List;
  26 import lombok.AccessLevel;
  27 import lombok.NoArgsConstructor;
  28 import lombok.NonNull;
  29
  30 /**
  31  * This class is the base class for all Policy Framework concept classes. It enforces implementation of abstract methods
  32  * and interfaces on all concepts that are sub-classes of this class.
  33  */
  34
  35 @NoArgsConstructor(access = AccessLevel.PROTECTED)
  36 public abstract class PfConcept extends Validated implements Serializable, Comparable<PfConcept> {
  37     private static final long serialVersionUID = -7434939557282697490L;
  38
  39     /**
  40      * Copy constructor.
  41      *
  42      * @param copyConcept the concept to copy from
  43      */
  44     protected PfConcept(@NonNull final PfConcept copyConcept) {
  45         // nothing else to do (other than @NonNull check)
  46     }
  47
  48     /**
  49      * Gets the key of this concept.
  50      *
  51      * @return the concept key
  52      */
  53     public abstract PfKey getKey();
  54
  55     /**
  56      * Gets a list of all keys for this concept and all concepts that are defined or referenced by this concept and its
  57      * sub-concepts.
  58      *
  59      * @return the keys used by this concept and its contained concepts
  60      */
  61     public abstract List<PfKey> getKeys();
  62
  63     /**
  64      * Clean this concept, tidy up any superfluous information such as leading and trailing white space.
  65      */
  66     public abstract void clean();
  67
  68     @Override
  69     public abstract boolean equals(Object otherObject);
  70
  71     @Override
  72     public abstract String toString();
  73
  74     @Override
  75     public abstract int hashCode();
  76
  77     /**
  78      * Gets the ID string of this concept.
  79      *
  80      * @return the ID string of this concept
  81      */
  82     public String getId() {
  83         return getKey().getId();
  84     }
  85
  86     /**
  87      * Gets the name of this concept.
  88      *
  89      * @return the name of this concept
  90      */
  91     public String getName() {
  92         return getKey().getName();
  93     }
  94
  95     /**
  96      * Gets the version of this concept.
  97      *
  98      * @return the version of this concept
  99      */
 100     public String getVersion() {
 101         return getKey().getVersion();
 102     }
 103
 104     /**
 105      * Checks if this key matches the given key ID.
 106      *
 107      * @param id the key ID to match against
 108      * @return true, if this key matches the ID
 109      */
 110     public final boolean matchesId(@NonNull final String id) {
 111         // Check the ID
 112         return getId().equals(id);
 113     }
 114 }