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 b98f15c69a5792a5e0614a8eb1ac8a54f10399c5..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,5 +1,6 @@
 /*
- * 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
@@ -7,7 +8,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;
@@ -16,7 +16,10 @@ 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 {
 
     /**
@@ -70,10 +73,10 @@ public interface TypeDefinitionBuilder extends TypeAwareBuilder, SchemaNodeBuild
     List<PatternConstraint> getPatterns();
 
     /**
-     * Set length restrictions for resulting type definition.
+     * Set pattern restrictions for resulting type definition.
      *
-     * @param lengths
-     *            Length restrictions of resulting type definition.
+     * @param patterns
+     *            patterns restrictions of resulting type definition.
      */
     void setPatterns(List<PatternConstraint> patterns);
 
@@ -87,11 +90,10 @@ public interface TypeDefinitionBuilder extends TypeAwareBuilder, SchemaNodeBuild
     Integer getFractionDigits();
 
     /**
+     * Sets fractions digits of resulting type if it is derived from
+     * <code>decimal</code> built-in type.
      *
-     * Sets fractions digits of resulting type if it is derived
-     * from <code>decimal</code> built-in type.
-     *
-     * @return fractions digits of resulting type
+     * @param fractionDigits fraction digits
      */
     void setFractionDigits(Integer fractionDigits);