BUG-6533: add immutable implementations of yang.model.api

[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / type / BinaryTypeDefinition.java

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/BinaryTypeDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/BinaryTypeDefinition.java
index 27856a42c5787eb31ad339aaa344ff3ed846fcd3..94eca2b9e4c5014c240b7545d404a4b4a08e5b15 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/BinaryTypeDefinition.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/BinaryTypeDefinition.java
@@ -8,12 +8,11 @@
 package org.opendaylight.yangtools.yang.model.api.type;
 
 import java.util.List;
-
 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 
 /**
  * The binary built-in type represents any binary data, i.e., a sequence of
- * octets. <br>
+ * octets.
  * <br>
  * Binary values are encoded with the base64 encoding scheme (see <a
  * href="https://tools.ietf.org/html/rfc4648#section-4">[RFC4648], Section
@@ -22,21 +21,19 @@ import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  * href="https://tools.ietf.org/html/rfc4648">[RFC4648]</a>.
  *
  * <br>
- * <br>
  * This interface was modeled according to definition in <a
  * href="https://tools.ietf.org/html/rfc6020#section-9.8">[RFC-6020] The binary
  * Built-In Type</a>
- *
  */
-public interface BinaryTypeDefinition extends
-        TypeDefinition<BinaryTypeDefinition> {
+public interface BinaryTypeDefinition extends TypeDefinition<BinaryTypeDefinition> {
 
     /**
-     * Returns List of number of octets that binary value contains.
+     * Returns List of number of octets that binary value contains. These are the effective constraints, e.g. they include
+     * any range constraints imposed by base types.
      *
      * @return List of number of octets that binary value contains.
      *
      * @see LengthConstraint
      */
-    public List<LengthConstraint> getLengthConstraints();
+    List<LengthConstraint> getLengthConstraints();
 }