yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/RangeConstraintImpl.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.model.util;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import java.util.Objects;
  13 import org.opendaylight.yangtools.concepts.Immutable;
  14 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
  15 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
  16
  17 /**
  18  * {@link Immutable} implementation of {@link LengthConstraint}.
  19  *
  20  * Range constraint based on supplied parameters with additional behaviour:
  21  *
  22  * <ul>
  23  * <li>{@link RangeConstraint#getErrorAppTag()} returns
  24  * <code>range-out-of-specified-bounds</code>
  25  * <li>{@link RangeConstraint#getErrorMessage() returns <code>The argument is
  26  * out of bounds &lt;<i>min</i>, <i>max</i> &gt;</code>
  27  * </ul>
  28  */
  29 final class RangeConstraintImpl implements RangeConstraint, Immutable {
  30     private final Number min;
  31     private final Number max;
  32
  33     private final String description;
  34     private final String reference;
  35
  36     private final String errorAppTag;
  37     private final String errorMessage;
  38
  39     RangeConstraintImpl(final Number min, final Number max, final Optional<String> description,
  40             final Optional<String> reference) {
  41         super();
  42         this.min = Preconditions.checkNotNull(min, "min must not be null.");
  43         this.max = Preconditions.checkNotNull(max, "max must not be null.");
  44         this.description = description.orNull();
  45         this.reference = reference.orNull();
  46
  47         this.errorAppTag = "range-out-of-specified-bounds";
  48         this.errorMessage = "The argument is out of bounds <" + min + ", " + max + ">";
  49     }
  50
  51     @Override
  52     public String getDescription() {
  53         return description;
  54     }
  55
  56     @Override
  57     public String getErrorAppTag() {
  58         return errorAppTag;
  59     }
  60
  61     @Override
  62     public String getErrorMessage() {
  63         return errorMessage;
  64     }
  65
  66     @Override
  67     public String getReference() {
  68         return reference;
  69     }
  70
  71     @Override
  72     public Number getMin() {
  73         return min;
  74     }
  75
  76     @Override
  77     public Number getMax() {
  78         return max;
  79     }
  80
  81     @Override
  82     public int hashCode() {
  83         final int prime = 31;
  84         int result = 1;
  85         result = prime * result + Objects.hashCode(description);
  86         result = prime * result + errorAppTag.hashCode();
  87         result = prime * result + errorMessage.hashCode();
  88         result = prime * result + max.hashCode();
  89         result = prime * result + min.hashCode();
  90         result = prime * result + Objects.hashCode(reference);
  91         return result;
  92     }
  93
  94     @Override
  95     public boolean equals(final Object obj) {
  96         if (this == obj) {
  97             return true;
  98         }
  99         if (!(obj instanceof RangeConstraintImpl)) {
 100             return false;
 101         }
 102         final RangeConstraintImpl other = (RangeConstraintImpl) obj;
 103         return Objects.equals(description, other.description) && Objects.equals(max, other.max)
 104                 && Objects.equals(min, other.min) && Objects.equals(reference, other.reference);
 105     }
 106
 107     @Override
 108     public String toString() {
 109         return "RangeConstraintImpl [min=" +
 110                 min +
 111                 ", max=" +
 112                 max +
 113                 ", description=" +
 114                 description +
 115                 ", reference=" +
 116                 reference +
 117                 ", errorAppTag=" +
 118                 errorAppTag +
 119                 ", errorMessage=" +
 120                 errorMessage +
 121                 "]";
 122     }
 123 }