BUG-865: deprecate pre-Beryllium parser elements

[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 acdec6621219fa07ebb8b5de7b1cc57cc8d2d4af..e6b6499f913a4a615050105653be2e12429790c5 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,51 +1,130 @@
-/*\r
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-package org.opendaylight.yangtools.yang.parser.builder.api;\r
-\r
-import java.util.List;\r
-\r
-import org.opendaylight.yangtools.yang.common.QName;\r
-import org.opendaylight.yangtools.yang.model.api.TypeDefinition;\r
-import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;\r
-import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;\r
-import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;\r
-\r
-/**\r
- * Interface for builders of 'typedef' statement.\r
- */\r
-public interface TypeDefinitionBuilder extends TypeAwareBuilder, SchemaNodeBuilder, GroupingMember {\r
-\r
-    void setQName(QName qname);\r
-\r
-    TypeDefinition<?> build();\r
-\r
-    List<RangeConstraint> getRanges();\r
-\r
-    void setRanges(List<RangeConstraint> ranges);\r
-\r
-    List<LengthConstraint> getLengths();\r
-\r
-    void setLengths(List<LengthConstraint> lengths);\r
-\r
-    List<PatternConstraint> getPatterns();\r
-\r
-    void setPatterns(List<PatternConstraint> patterns);\r
-\r
-    Integer getFractionDigits();\r
-\r
-    void setFractionDigits(Integer fractionDigits);\r
-\r
-    Object getDefaultValue();\r
-\r
-    void setDefaultValue(Object defaultValue);\r
-\r
-    String getUnits();\r
-\r
-    void setUnits(String units);\r
-\r
-}\r
+/*
+ * 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
+ */
+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;
+import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
+import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
+
+/**
+ * Interface for builders of 'typedef' statement.
+ *
+ * @deprecated Pre-Beryllium implementation, scheduled for removal.
+ */
+@Deprecated
+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.
+     *
+     * @param fractionDigits fraction digits
+     */
+    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);
+
+}