opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/type/RangeConstraint.java

   1 /*
   2  * Copyright (c) 2013 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.controller.yang.model.api.type;
   9
  10 import org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition;
  11
  12 /**
  13  * The Range Constraint interface is used to restrict integer and decimal
  14  * built-in types, or types derived from those.
  15  * <br>
  16  * A range consists of an explicit value consists of an explicit value, or a lower bound
  17  * returned by {@link #getMin()} and an upper bound returned by
  18  * {@link #getMax()}. <br>
  19  * <br>
  20  * Each explicit value and range boundary value given in
  21  * the range expression MUST match the type being restricted, or be one of the
  22  * special values "min" or "max". "min" and "max" mean the minimum and maximum
  23  * value accepted for the type being restricted, respectively
  24  * <br>
  25  * <br>
  26  * This interface was modeled according to definition in <a
  27  * href="https://tools.ietf.org/html/rfc6020#section-9.2.4">[RFC-6020] The
  28  * range Statement</a>.
  29  */
  30 public interface RangeConstraint extends ConstraintMetaDefinition {
  31
  32     /**
  33      * Returns the length-restricting lower bound value.
  34      *
  35      * @return the length-restricting lower bound value.
  36      */
  37     Number getMin();
  38
  39     /**
  40      * Returns the length-restricting upper bound value.
  41      *
  42      * @return the length-restricting upper bound value.
  43      */
  44     Number getMax();
  45 }