BUG-4268: clarify length constraint API contract

[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 8d87fca7735456afd225f7886c77d9c60d630d4c..b097fd3d87d6ae81e822ae306fa8fc66bfd7fb70 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,7 +8,6 @@
 package org.opendaylight.yangtools.yang.model.api.type;
 
 import java.util.List;
-
 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 
 /**
@@ -20,21 +19,21 @@ import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  * 4</a>). <br>
  * The canonical form of a binary value follows the rules in <a
  * 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> {
 
     /**
-     * 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
      */
     List<LengthConstraint> getLengthConstraints();