models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/ToscaConstraintLogical.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 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.tosca.simple.concepts;
  22
  23 import javax.persistence.Column;
  24 import javax.ws.rs.core.Response;
  25
  26 import lombok.EqualsAndHashCode;
  27 import lombok.Getter;
  28 import lombok.NonNull;
  29 import lombok.ToString;
  30
  31 import org.onap.policy.models.base.PfConcept;
  32 import org.onap.policy.models.base.PfModelRuntimeException;
  33 import org.onap.policy.models.base.PfReferenceKey;
  34
  35 /**
  36  * This class represents a logical TOSCA constraint: =,>,>=,<,<=.
  37  */
  38 @EqualsAndHashCode(callSuper = false)
  39 @ToString
  40 public class ToscaConstraintLogical extends ToscaConstraint {
  41     private static final long serialVersionUID = 2562306457768745444L;
  42
  43     public enum Operation {
  44         EQ,
  45         GT,
  46         GE,
  47         LT,
  48         LE
  49     }
  50
  51     @Column
  52     @NonNull
  53     @Getter
  54     private final Operation operation;
  55
  56     /**
  57      * The Default Constructor creates a {@link ToscaConstraintLogical} object with a null key.
  58      */
  59     public ToscaConstraintLogical() {
  60         this(new PfReferenceKey());
  61     }
  62
  63     /**
  64      * The Key Constructor creates a {@link ToscaConstraintLogical} object with the given concept key.
  65      *
  66      * @param key the key of the constraint
  67      */
  68     public ToscaConstraintLogical(final PfReferenceKey key) {
  69         this(key, Operation.EQ);
  70     }
  71
  72     /**
  73      * The Key Constructor creates a {@link ToscaConstraintLogical} object with the given concept key and operation.
  74      *
  75      * @param key the key of the constraint
  76      * @param operation the logical operation of the constraint
  77      *
  78      */
  79     public ToscaConstraintLogical(final PfReferenceKey key, @NonNull final Operation operation) {
  80         super(key);
  81         this.operation = operation;
  82     }
  83
  84     /**
  85      * Copy constructor.
  86      *
  87      * @param copyConcept the concept to copy from
  88      */
  89     public ToscaConstraintLogical(@NonNull final ToscaConstraintLogical copyConcept) {
  90         throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, "cannot copy an immutable constraint");
  91     }
  92
  93     @Override
  94     public int compareTo(final PfConcept otherConcept) {
  95         if (otherConcept == null) {
  96             return -1;
  97         }
  98         if (this == otherConcept) {
  99             return 0;
 100         }
 101         if (getClass() != otherConcept.getClass()) {
 102             return this.hashCode() - otherConcept.hashCode();
 103         }
 104
 105         final ToscaConstraintLogical other = (ToscaConstraintLogical) otherConcept;
 106
 107         int result = super.compareTo(other);
 108         if (result != 0) {
 109             return result;
 110         }
 111
 112         return operation.compareTo(other.operation);
 113     }
 114
 115     @Override
 116     public PfConcept copyTo(@NonNull final PfConcept target) {
 117         throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, "cannot copy an immutable constraint");
 118     }
 119 }