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 org.opendaylight.controller.yang.model.api.TypeDefinition;\r
  11 \r
  12 /**\r
  13  * The binary built-in type represents any binary data, i.e., a sequence of\r
  14  * octets. <br>\r
  15  * <br>\r
  16  * Binary values are encoded with the base64 encoding scheme (see <a\r
  17  * href="https://tools.ietf.org/html/rfc4648#section-4">[RFC4648], Section\r
  18  * 4</a>). <br>\r
  19  * The canonical form of a binary value follows the rules in <a\r
  20  * href="https://tools.ietf.org/html/rfc4648">[RFC4648]</a>.\r
  21  * \r
  22  * \r
  23  */\r
  24 public interface BinaryTypeDefinition extends\r
  25         TypeDefinition<BinaryTypeDefinition> {\r
  26 \r
  27     /**\r
  28      * Returns the number of octets it that binary value contains.\r
  29      * \r
  30      * @return the number of octets it that binary value contains.\r
  31      */\r
  32     public LengthConstraint getLengthConstraint();\r
  33 }\r