Added javadoc and RFC references to Java YANG model.
[controller.git] / opendaylight / sal / yang-prototype / yang / yang-model-api / src / main / java / org / opendaylight / controller / model / api / type / IntegerTypeDefinition.java
1 /*\r
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
3  *\r
4  * This program and the accompanying materials are made available under the\r
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
7  */\r
8 package org.opendaylight.controller.model.api.type;\r
9 \r
10 import java.util.List;\r
11 \r
12 import org.opendaylight.controller.yang.model.api.TypeDefinition;\r
13 \r
14 /**\r
15  * IntegerTypeDefinition is interface which represents SIGNED Integer values\r
16  * defined in Yang language. <br>\r
17  * The integer built-in types in Yang are int8, int16, int32, int64. They\r
18  * represent signed integers of different sizes: <br>\r
19  * <ul>\r
20  * <li>int8 represents integer values between -128 and 127, inclusively.</li>\r
21  * <li>int16 represents integer values between -32768 and 32767, inclusively.</li>\r
22  * <li>int32 represents integer values between -2147483648 and 2147483647,\r
23  * inclusively.</li>\r
24  * <li>int64 represents integer values between -9223372036854775808 and\r
25  * 9223372036854775807, inclusively.</li>\r
26  * </ul>\r
27  * \r
28  * The Integer Built-In Types are defined in <a\r
29  * href="https://tools.ietf.org/html/rfc6020#section-9.2"> [RFC-6020]</a>\r
30  */\r
31 public interface IntegerTypeDefinition extends\r
32         TypeDefinition<IntegerTypeDefinition> {\r
33 \r
34     /**\r
35      * Returns Range Constraints defined for given Integer Type.\r
36      * \r
37      * @return Range Constraints defined for given Integer Type.\r
38      */\r
39     List<RangeConstraint> getRangeStatements();\r
40 }\r

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.