Comments added to a source codes.

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

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/PatternConstraint.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/PatternConstraint.java
index d793b24ee0f0aae3800c9fd39cc63974dd85c93c..aab99fd794585fb3912954c4a8da06ac2351b5d4 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/PatternConstraint.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/PatternConstraint.java
@@ -9,7 +9,18 @@ package org.opendaylight.yangtools.yang.model.api.type;
 
 import org.opendaylight.yangtools.yang.model.api.ConstraintMetaDefinition;
 
+/**
+ * Contains the method for getting the data from the YANG <code>pattern</code>
+ * which is substatement of <code>type</code> statement.
+ * 
+ */
 public interface PatternConstraint extends ConstraintMetaDefinition {
 
+    /**
+     * Returns a regular expression (pattern).
+     * 
+     * @return string with regular expression which is equal to the argument of
+     *         the YANG <code>pattern</code> substatement
+     */
     public String getRegularExpression();
 }