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