From: Lukas Sedlak Date: Thu, 28 Mar 2013 12:09:04 +0000 (+0100) Subject: Added javadoc and RFC references to Java YANG model. X-Git-Tag: releasepom-0.1.0~623 X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=commitdiff_plain;h=831844b15c26d2e104efff31405032ac09b3095f;hp=69cf49d6fa850309d11a46dcb36958e21b4d39f7 Added javadoc and RFC references to Java YANG model. Signed-off-by: Tony Tkacik --- diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/BinaryTypeDefinition.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/BinaryTypeDefinition.java index e99bbb14c6..91031737c4 100644 --- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/BinaryTypeDefinition.java +++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/BinaryTypeDefinition.java @@ -20,16 +20,23 @@ import org.opendaylight.controller.yang.model.api.TypeDefinition; * 4).
* The canonical form of a binary value follows the rules in [RFC4648]. - * - * + * + *
+ *
+ * This interface was modeled according to definition in [RFC-6020] The binary + * Built-In Type + * */ public interface BinaryTypeDefinition extends TypeDefinition { /** * Returns List of number of octets that binary value contains. - * + * * @return List of number of octets that binary value contains. + * + * @see LengthConstraint */ public List getLengthConstraints(); } diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/IntegerTypeDefinition.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/IntegerTypeDefinition.java index 92f3098a23..5b40c49f3e 100644 --- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/IntegerTypeDefinition.java +++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/IntegerTypeDefinition.java @@ -11,8 +11,30 @@ import java.util.List; import org.opendaylight.controller.yang.model.api.TypeDefinition; +/** + * IntegerTypeDefinition is interface which represents SIGNED Integer values + * defined in Yang language.
+ * The integer built-in types in Yang are int8, int16, int32, int64. They + * represent signed integers of different sizes:
+ *
    + *
  • int8 represents integer values between -128 and 127, inclusively.
    • + *
  • int16 represents integer values between -32768 and 32767, inclusively.
    • + *
  • int32 represents integer values between -2147483648 and 2147483647, + * inclusively.
    • + *
  • int64 represents integer values between -9223372036854775808 and + * 9223372036854775807, inclusively.
    • + *
+ * + * The Integer Built-In Types are defined in [RFC-6020] + */ public interface IntegerTypeDefinition extends TypeDefinition { + /** + * Returns Range Constraints defined for given Integer Type. + * + * @return Range Constraints defined for given Integer Type. + */ List getRangeStatements(); } diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/LengthConstraint.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/LengthConstraint.java index 8c9cb79ad0..97f4448f57 100644 --- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/LengthConstraint.java +++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/LengthConstraint.java @@ -9,9 +9,42 @@ package org.opendaylight.controller.model.api.type; import org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition; +/** + * The Lenght Constraint value consists of an explicit value, or a lower bound + * returned by {@link #getMin()} and an upper bound returned by + * {@link #getMax()}.
+ *
+ * Length-restricting values MUST NOT be negative. A length value is a + * non-negative integer, or one of the special values min or + * max. The defined min and max mean the + * minimum and maximum length accepted for the type being restricted, + * respectively.
+ * An implementation is not required to support a length value larger than + * {@link Long#MAX_VALUE}
+ *
+ * The interface extends definitions from {@link ConstraintMetaDefinition}
+ *
+ * This interface was modeled according to definition in [RFC-6020] The + * length Statement. + * + * @see ConstraintMetaDefinition + */ public interface LengthConstraint extends ConstraintMetaDefinition { + /** + * Returns the length-restricting lower bound value.
+ * The value MUST NOT be negative. + * + * @return the length-restricting lower bound value. + */ Long getMin(); + /** + * Returns the length-restricting upper bound value.
+ * The value MUST NOT be negative. + * + * @return length-restricting upper bound value. + */ Long getMax(); } diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/RangeConstraint.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/RangeConstraint.java index 76bfb75301..12fbb1bcd5 100644 --- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/RangeConstraint.java +++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/RangeConstraint.java @@ -9,9 +9,37 @@ package org.opendaylight.controller.model.api.type; import org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition; +/** + * The Range Constraint interface is used to restrict integer and decimal + * built-in types, or types derived from those. + *
+ * A range consists of an explicit value consists of an explicit value, or a lower bound + * returned by {@link #getMin()} and an upper bound returned by + * {@link #getMax()}.
+ *
+ * Each explicit value and range boundary value given in + * the range expression MUST match the type being restricted, or be one of the + * special values "min" or "max". "min" and "max" mean the minimum and maximum + * value accepted for the type being restricted, respectively + *
+ *
+ * This interface was modeled according to definition in [RFC-6020] The + * range Statement. + */ public interface RangeConstraint extends ConstraintMetaDefinition { - Long getMin(); + /** + * Returns the length-restricting lower bound value. + * + * @return the length-restricting lower bound value. + */ + Number getMin(); - Long getMax(); + /** + * Returns the length-restricting upper bound value. + * + * @return the length-restricting upper bound value. + */ + Number getMax(); } diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/TypeDefinition.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/TypeDefinition.java index acc8a34828..0f098422eb 100644 --- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/TypeDefinition.java +++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/TypeDefinition.java @@ -7,6 +7,7 @@ */ package org.opendaylight.controller.yang.model.api; + public interface TypeDefinition> extends SchemaNode { T getBaseType();