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 / BinaryTypeDefinition.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  * The binary built-in type represents any binary data, i.e., a sequence of\r
16  * octets. <br>\r
17  * <br>\r
18  * Binary values are encoded with the base64 encoding scheme (see <a\r
19  * href="https://tools.ietf.org/html/rfc4648#section-4">[RFC4648], Section\r
20  * 4</a>). <br>\r
21  * The canonical form of a binary value follows the rules in <a\r
22  * href="https://tools.ietf.org/html/rfc4648">[RFC4648]</a>.\r
23  * \r
24  * <br>\r
25  * <br>\r
26  * This interface was modeled according to definition in <a\r
27  * href="https://tools.ietf.org/html/rfc6020#section-9.8">[RFC-6020] The binary\r
28  * Built-In Type</a>\r
29  * \r
30  */\r
31 public interface BinaryTypeDefinition extends\r
32         TypeDefinition<BinaryTypeDefinition> {\r
33 \r
34     /**\r
35      * Returns List of number of octets that binary value contains.\r
36      * \r
37      * @return List of number of octets that binary value contains.\r
38      * \r
39      * @see LengthConstraint\r
40      */\r
41     public List<LengthConstraint> getLengthConstraints();\r
42 }\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.