Comments added to a source codes.

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

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/StringTypeDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/StringTypeDefinition.java
index c12499eb6be0c2f32193f34298461a1157320e9d..e1bf21ada41fd25c1571c811b397ed4b0a1462a7 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/StringTypeDefinition.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/StringTypeDefinition.java
@@ -11,10 +11,28 @@ import java.util.List;
 
 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 
-public interface StringTypeDefinition extends
-        TypeDefinition<StringTypeDefinition> {
+/**
+ * 
+ * Contains method for getting data from the <code>string</code> YANG built-in
+ * type.
+ */
+public interface StringTypeDefinition extends TypeDefinition<StringTypeDefinition> {
 
+    /**
+     * Returns length constraint specified in the string.
+     * 
+     * @return list of length constraint which are specified in the
+     *         <code>lenght</code> substatement of the <code>type</code>
+     *         statement
+     */
     List<LengthConstraint> getLengthStatements();
 
+    /**
+     * Returns patterns specified in the string.
+     * 
+     * @return list of pattern constraints which are specified in the
+     *         <code>pattern</code> substatement of the <code>type</code>
+     *         statement
+     */
     List<PatternConstraint> getPatterns();
 }