Merge "BUG-1537: improved YangModuleInfo."

[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / api / TypeDefinitionBuilder.java

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/TypeDefinitionBuilder.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/TypeDefinitionBuilder.java
index 1b4eed27f1b2a018a9ecdc436371b008119ea69b..068130fbf80ddfd4363a59d2ce447f08cc4cd89f 100644 (file)
--- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/TypeDefinitionBuilder.java
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/TypeDefinitionBuilder.java
@@ -1,6 +1,5 @@
 /*
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
- *
+ * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
@@ -8,7 +7,6 @@
 package org.opendaylight.yangtools.yang.parser.builder.api;
 
 import java.util.List;
-
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
@@ -20,32 +18,107 @@ import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
  */
 public interface TypeDefinitionBuilder extends TypeAwareBuilder, SchemaNodeBuilder, GroupingMember {
 
+    /**
+     * Sets QName for resulting type definition.
+     *
+     * @param qname QName of resulting type
+     */
     void setQName(QName qname);
 
+    @Override
     TypeDefinition<?> build();
 
+    /**
+     *
+     * Returns range restrictions of resulting type definition.
+     *
+     * @return range restrictions of resulting type definition.
+     */
     List<RangeConstraint> getRanges();
 
+    /**
+     * Set Range restrictions for resulting type definition.
+     *
+     * @param ranges
+     *            Range restrictions of resulting type definition.
+     */
     void setRanges(List<RangeConstraint> ranges);
 
+    /**
+     *
+     * Returns length restrictions of resulting type definition.
+     *
+     * @return length restrictions of resulting type definition.
+     */
     List<LengthConstraint> getLengths();
 
+    /**
+     * Set length restrictions for resulting type definition.
+     *
+     * @param lengths
+     *            Length restrictions of resulting type definition.
+     */
     void setLengths(List<LengthConstraint> lengths);
 
+    /**
+     *
+     * Returns pattern restrictions of resulting type definition.
+     *
+     * @return range restrictions of resulting type definition.
+     */
     List<PatternConstraint> getPatterns();
 
+    /**
+     * Set pattern restrictions for resulting type definition.
+     *
+     * @param patterns
+     *            patterns restrictions of resulting type definition.
+     */
     void setPatterns(List<PatternConstraint> patterns);
 
+    /**
+     *
+     * Returns fractions digits of resulting type if it is derived
+     * from <code>decimal</code> built-in type.
+     *
+     * @return fractions digits of resulting type
+     */
     Integer getFractionDigits();
 
+    /**
+     * Sets fractions digits of resulting type if it is derived from
+     * <code>decimal</code> built-in type.
+     */
     void setFractionDigits(Integer fractionDigits);
 
+    /**
+     *
+     * Returns default value of resulting type
+     *
+     * @return default value of resulting type
+     */
     Object getDefaultValue();
 
+    /**
+     *
+     * Sets default value of resulting type
+     *
+     * @param defaultValue Default value of resulting type
+     */
     void setDefaultValue(Object defaultValue);
 
+    /**
+     * Gets unit definition for resulting type
+     *
+     * @return unit definition for resulting type
+     */
     String getUnits();
 
+    /**
+     * Sets units definition for resulting type
+     *
+     * @param units units definition for resulting type
+     */
     void setUnits(String units);
 
 }