BUG-865: mark yang-model-util types as deprecated
[yangtools.git] / yang / yang-model-util / src / main / java / org / opendaylight / yangtools / yang / model / util / StringType.java
index 93f0c7c13c5bf58944fac59033a4f388cd5cd150..911ed2c37ad0a8d91ff4acd6db3feefff796d54f 100644 (file)
@@ -7,10 +7,11 @@
  */
 package org.opendaylight.yangtools.yang.model.util;
 
-import java.util.ArrayList;
+import com.google.common.base.Optional;
 import java.util.Collections;
 import java.util.List;
-
+import java.util.Objects;
+import org.opendaylight.yangtools.concepts.Immutable;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 import org.opendaylight.yangtools.yang.model.api.Status;
@@ -21,48 +22,49 @@ import org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition;
 
 /**
  * The <code>default</code> implementation of String Type Definition interface.
- * 
+ *
  * @see StringTypeDefinition
+ * @deprecated Use {@link org.opendaylight.yangtools.yang.model.util.type.BaseTypes#stringType()} instead
  */
-public final class StringType implements StringTypeDefinition {
-    private static final StringType INSTANCE = new StringType();
-    private final QName name = BaseTypes.constructQName("string");
-    private final SchemaPath path = new SchemaPath(Collections.singletonList(name), true);
-    private static final String DEFAULT_VALUE = "";
+@Deprecated
+public final class StringType implements StringTypeDefinition, Immutable {
+    private static final QName NAME = BaseTypes.STRING_QNAME;
+    private static final SchemaPath PATH = SchemaPath.create(true, NAME);
+    private static final String DEFAULT_VALUE = null;
     private static final String DESCRIPTION = "";
     private static final String REFERENCE = "";
     private final List<LengthConstraint> lengthStatements;
     private final List<PatternConstraint> patterns;
     private static final String UNITS = "";
 
+    private static final StringType INSTANCE = new StringType();
+
     /**
      * Default Constructor.
      */
     private StringType() {
-        final List<LengthConstraint> constraints = new ArrayList<LengthConstraint>();
-        constraints.add(BaseConstraints.lengthConstraint(0, Long.MAX_VALUE, "", ""));
-        lengthStatements = Collections.unmodifiableList(constraints);
+        lengthStatements = Collections.singletonList(BaseConstraints.newLengthConstraint(0, Integer.MAX_VALUE, Optional.of(""), Optional.of("")));
         patterns = Collections.emptyList();
     }
 
-    public static StringType getIntance() {
+    public static StringType getInstance() {
         return INSTANCE;
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see
      * org.opendaylight.yangtools.yang.model.api.TypeDefinition#getBaseType()
      */
     @Override
     public StringTypeDefinition getBaseType() {
-        return this;
+        return null;
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.opendaylight.yangtools.yang.model.api.TypeDefinition#getUnits()
      */
     @Override
@@ -72,7 +74,7 @@ public final class StringType implements StringTypeDefinition {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see
      * org.opendaylight.yangtools.yang.model.api.TypeDefinition#getDefaultValue
      * ()
@@ -84,27 +86,27 @@ public final class StringType implements StringTypeDefinition {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.opendaylight.yangtools.yang.model.api.SchemaNode#getQName()
      */
     @Override
     public QName getQName() {
-        return name;
+        return NAME;
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.opendaylight.yangtools.yang.model.api.SchemaNode#getPath()
      */
     @Override
     public SchemaPath getPath() {
-        return path;
+        return PATH;
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see
      * org.opendaylight.yangtools.yang.model.api.SchemaNode#getDescription()
      */
@@ -115,7 +117,7 @@ public final class StringType implements StringTypeDefinition {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.opendaylight.yangtools.yang.model.api.SchemaNode#getReference()
      */
     @Override
@@ -125,7 +127,7 @@ public final class StringType implements StringTypeDefinition {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.opendaylight.yangtools.yang.model.api.SchemaNode#getStatus()
      */
     @Override
@@ -135,24 +137,24 @@ public final class StringType implements StringTypeDefinition {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see
      * com.csico.yang.model.base.type.api.StringTypeDefinition#getLengthStatements
      * ()
      */
     @Override
-    public List<LengthConstraint> getLengthStatements() {
+    public List<LengthConstraint> getLengthConstraints() {
         return lengthStatements;
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see
      * com.csico.yang.model.base.type.api.StringTypeDefinition#getPatterns()
      */
     @Override
-    public List<PatternConstraint> getPatterns() {
+    public List<PatternConstraint> getPatternConstraints() {
         return patterns;
     }
 
@@ -165,15 +167,15 @@ public final class StringType implements StringTypeDefinition {
     public int hashCode() {
         final int prime = 31;
         int result = 1;
-        result = prime * result + ((lengthStatements == null) ? 0 : lengthStatements.hashCode());
-        result = prime * result + ((name == null) ? 0 : name.hashCode());
-        result = prime * result + ((path == null) ? 0 : path.hashCode());
-        result = prime * result + ((patterns == null) ? 0 : patterns.hashCode());
+        result = prime * result + Objects.hashCode(lengthStatements);
+        result = prime * result + NAME.hashCode();
+        result = prime * result + PATH.hashCode();
+        result = prime * result + Objects.hashCode(patterns);
         return result;
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(final Object obj) {
         if (this == obj) {
             return true;
         }
@@ -184,44 +186,16 @@ public final class StringType implements StringTypeDefinition {
             return false;
         }
         StringType other = (StringType) obj;
-        if (lengthStatements == null) {
-            if (other.lengthStatements != null) {
-                return false;
-            }
-        } else if (!lengthStatements.equals(other.lengthStatements)) {
-            return false;
-        }
-        if (name == null) {
-            if (other.name != null) {
-                return false;
-            }
-        } else if (!name.equals(other.name)) {
-            return false;
-        }
-        if (path == null) {
-            if (other.path != null) {
-                return false;
-            }
-        } else if (!path.getPath().equals(other.path.getPath())) {
-            return false;
-        }
-        if (patterns == null) {
-            if (other.patterns != null) {
-                return false;
-            }
-        } else if (!patterns.equals(other.patterns)) {
-            return false;
-        }
-        return true;
+        return Objects.equals(lengthStatements, other.lengthStatements) && Objects.equals(patterns, other.patterns);
     }
 
     @Override
     public String toString() {
         StringBuilder builder = new StringBuilder();
         builder.append("StringType [name=");
-        builder.append(name);
+        builder.append(NAME);
         builder.append(", path=");
-        builder.append(path);
+        builder.append(PATH);
         builder.append(", defaultValue=");
         builder.append(DEFAULT_VALUE);
         builder.append(", description=");