yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/IntegerTypeDefinition.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.yangtools.yang.model.api.type;
   9
  10 import java.util.List;
  11 import javax.annotation.Nonnull;
  12 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  13
  14 /**
  15  * IntegerTypeDefinition is interface which represents SIGNED Integer values defined in Yang language.<br>
  16  * The integer built-in types in Yang are int8, int16, int32, int64. They represent signed integers of different
  17  * sizes:<br>
  18  * <ul>
  19  * <li>int8 represents integer values between -128 and 127, inclusively.</li>
  20  * <li>int16 represents integer values between -32768 and 32767, inclusively.</li>
  21  * <li>int32 represents integer values between -2147483648 and 2147483647, inclusively.</li>
  22  * <li>int64 represents integer values between -9223372036854775808 and 9223372036854775807, inclusively.</li>
  23  * </ul>
  24  *
  25  * <p>
  26  * The Integer Built-In Types are defined in <a href="https://tools.ietf.org/html/rfc6020#section-9.2"> [RFC-6020]</a>
  27  */
  28 public interface IntegerTypeDefinition extends TypeDefinition<IntegerTypeDefinition> {
  29     /**
  30      * Returns Range Constraints defined for given Integer Type. These are the effective constraints, e.g. they include
  31      * any range constraints imposed by base types.
  32      *
  33      * @return Range Constraints defined for given Integer Type.
  34      */
  35     @Nonnull List<RangeConstraint> getRangeConstraints();
  36 }