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