models-pdp/src/main/java/org/onap/policy/models/pdp/concepts/PdpGroup.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019 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.pdp.concepts;
  23
  24 import java.util.LinkedHashMap;
  25 import java.util.List;
  26 import java.util.Map;
  27
  28 import lombok.Data;
  29 import lombok.NoArgsConstructor;
  30
  31 import org.onap.policy.models.base.PfNameVersion;
  32 import org.onap.policy.models.base.PfUtils;
  33 import org.onap.policy.models.pdp.enums.PdpState;
  34
  35 /**
  36  * Class to represent a PDPGroup, which groups multiple PDPSubGroup entities together for
  37  * a particular domain.
  38  *
  39  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  40  */
  41 @Data
  42 @NoArgsConstructor
  43 public class PdpGroup implements PfNameVersion, Comparable<PdpGroup> {
  44     /**
  45      * In the future, we'll eliminate the "version" field. Until then, the version of
  46      * every group should always be this fixed value.
  47      */
  48     public static final String VERSION = "1.0.0";
  49
  50     private String name;
  51     private String version;
  52     private String description;
  53     private PdpState pdpGroupState;
  54     private Map<String, String> properties;
  55     private List<PdpSubGroup> pdpSubgroups;
  56
  57     /*
  58      * Note: removed "@NotNull" annotation from the constructor argument, because it
  59      * cannot be covered by a junit test, as the superclass does the check and throws an
  60      * exception first.
  61      */
  62
  63     /**
  64      * Constructs the object, making a deep copy from the source.
  65      *
  66      * @param source source from which to copy fields
  67      */
  68     public PdpGroup(PdpGroup source) {
  69         this.name = source.name;
  70         this.version = source.version;
  71         this.description = source.description;
  72         this.pdpGroupState = source.pdpGroupState;
  73         this.properties = (source.properties == null ? null : new LinkedHashMap<>(source.properties));
  74         this.pdpSubgroups = PfUtils.mapList(source.pdpSubgroups, PdpSubGroup::new);
  75     }
  76
  77     @Override
  78     public int compareTo(final PdpGroup other) {
  79         return compareNameVersion(this, other);
  80     }
  81 }