From d911236c08d1b2cba6d65d9954f3ab48cff5f61e Mon Sep 17 00:00:00 2001
From: Robert Varga <robert.varga@pantheon.sk>
Date: Sat, 2 Jan 2016 16:39:01 +0100
Subject: [PATCH] BUG-865: deprecate internal implementation classes

Derived*Type and Abstract*Integer are used as DerivedType subclasses and
for realization of deprecated base types. Eventhough they are not
externally visible, deprecate them to make their fate explicit.

Change-Id: Idffbcde09f16942605b66043144c0668557961ba
Signed-off-by: Robert Varga <robert.varga@pantheon.sk>
---
 .../yangtools/yang/model/util/AbstractSignedInteger.java      | 2 ++
 .../yangtools/yang/model/util/AbstractUnsignedInteger.java    | 2 ++
 .../yangtools/yang/model/util/DerivedBinaryType.java          | 4 ++++
 .../yangtools/yang/model/util/DerivedBitsType.java            | 4 ++++
 .../yangtools/yang/model/util/DerivedBooleanType.java         | 4 ++++
 .../yangtools/yang/model/util/DerivedDecimalType.java         | 4 ++++
 .../yangtools/yang/model/util/DerivedEnumType.java            | 4 ++++
 .../yangtools/yang/model/util/DerivedIdentityrefType.java     | 4 ++++
 .../yang/model/util/DerivedInstanceIdentifierType.java        | 4 ++++
 .../yangtools/yang/model/util/DerivedIntegerType.java         | 4 ++++
 .../yangtools/yang/model/util/DerivedLeafrefType.java         | 4 ++++
 .../yangtools/yang/model/util/DerivedStringType.java          | 4 ++++
 .../yangtools/yang/model/util/DerivedUnionType.java           | 4 ++++
 .../yangtools/yang/model/util/DerivedUnsignedIntegerType.java | 4 ++++
 14 files changed, 52 insertions(+)

diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/AbstractSignedInteger.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/AbstractSignedInteger.java
index d255e4f966..8bfe5607e7 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/AbstractSignedInteger.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/AbstractSignedInteger.java
@@ -33,7 +33,9 @@ import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
  * 9223372036854775807, inclusively.</li>
  * </ul>
  *
+ * @deprecated Used only by deprecated {@link Int8} and friends.
  */
+@Deprecated
 abstract class AbstractSignedInteger implements IntegerTypeDefinition {
     private final QName name;
     private final SchemaPath path;
diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/AbstractUnsignedInteger.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/AbstractUnsignedInteger.java
index 89225876f1..22f73fcfad 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/AbstractUnsignedInteger.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/AbstractUnsignedInteger.java
@@ -33,7 +33,9 @@ import org.opendaylight.yangtools.yang.model.api.type.UnsignedIntegerTypeDefinit
  * inclusively.</li>
  * </ul>
  *
+ * @deprecated Used only by deprecated {@link Uint8} and friends.
  */
+@Deprecated
 abstract class AbstractUnsignedInteger implements UnsignedIntegerTypeDefinition {
     private static final String REFERENCE = "https://tools.ietf.org/html/rfc6020#section-9.2";
     private static final Optional<String> OPT_REF = Optional.of("https://tools.ietf.org/html/rfc6020#section-9.2.4");
diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedBinaryType.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedBinaryType.java
index 5fb604b041..e056dded7c 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedBinaryType.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedBinaryType.java
@@ -11,6 +11,10 @@ import java.util.List;
 import org.opendaylight.yangtools.yang.model.api.type.BinaryTypeDefinition;
 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
 
+/**
+ * @deprecated Deprecated {@link DerivedType} subclass.
+ */
+@Deprecated
 class DerivedBinaryType extends DerivedType<BinaryTypeDefinition> implements BinaryTypeDefinition {
 
     public DerivedBinaryType(final ExtendedType definition) {
diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedBitsType.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedBitsType.java
index 3449742452..6ede0b5544 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedBitsType.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedBitsType.java
@@ -10,6 +10,10 @@ package org.opendaylight.yangtools.yang.model.util;
 import java.util.List;
 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
 
+/**
+ * @deprecated Deprecated {@link DerivedType} subclass.
+ */
+@Deprecated
 class DerivedBitsType extends DerivedType<BitsTypeDefinition> implements BitsTypeDefinition {
 
     public DerivedBitsType(final ExtendedType definition) {
diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedBooleanType.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedBooleanType.java
index 3225982d28..1e866d1982 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedBooleanType.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedBooleanType.java
@@ -9,6 +9,10 @@ package org.opendaylight.yangtools.yang.model.util;
 
 import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
 
+/**
+ * @deprecated Deprecated {@link DerivedType} subclass.
+ */
+@Deprecated
 class DerivedBooleanType extends DerivedType<BooleanTypeDefinition> implements BooleanTypeDefinition {
 
     public DerivedBooleanType(final ExtendedType definition) {
diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedDecimalType.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedDecimalType.java
index 79f93d2a72..a3e6602c94 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedDecimalType.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedDecimalType.java
@@ -11,6 +11,10 @@ import java.util.List;
 import org.opendaylight.yangtools.yang.model.api.type.DecimalTypeDefinition;
 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
 
+/**
+ * @deprecated Deprecated {@link DerivedType} subclass.
+ */
+@Deprecated
 class DerivedDecimalType extends DerivedType<DecimalTypeDefinition> implements DecimalTypeDefinition {
 
     public DerivedDecimalType(final ExtendedType definition) {
diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedEnumType.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedEnumType.java
index dcad297edf..94c7b80287 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedEnumType.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedEnumType.java
@@ -10,6 +10,10 @@ package org.opendaylight.yangtools.yang.model.util;
 import java.util.List;
 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
 
+/**
+ * @deprecated Deprecated {@link DerivedType} subclass.
+ */
+@Deprecated
 class DerivedEnumType extends DerivedType<EnumTypeDefinition> implements EnumTypeDefinition {
 
     public DerivedEnumType(final ExtendedType definition) {
diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedIdentityrefType.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedIdentityrefType.java
index 9dba85b58f..1d5418f353 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedIdentityrefType.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedIdentityrefType.java
@@ -10,6 +10,10 @@ package org.opendaylight.yangtools.yang.model.util;
 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
 
+/**
+ * @deprecated Deprecated {@link DerivedType} subclass.
+ */
+@Deprecated
 class DerivedIdentityrefType extends DerivedType<IdentityrefTypeDefinition> implements
         IdentityrefTypeDefinition {
 
diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedInstanceIdentifierType.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedInstanceIdentifierType.java
index e8ebecb4b8..09e47c2cc8 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedInstanceIdentifierType.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedInstanceIdentifierType.java
@@ -10,6 +10,10 @@ package org.opendaylight.yangtools.yang.model.util;
 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
 
+/**
+ * @deprecated Deprecated {@link DerivedType} subclass.
+ */
+@Deprecated
 class DerivedInstanceIdentifierType extends DerivedType<InstanceIdentifierTypeDefinition> implements
         InstanceIdentifierTypeDefinition {
 
diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedIntegerType.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedIntegerType.java
index a9f3f79f34..1ba130edc1 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedIntegerType.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedIntegerType.java
@@ -11,6 +11,10 @@ import java.util.List;
 import org.opendaylight.yangtools.yang.model.api.type.IntegerTypeDefinition;
 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
 
+/**
+ * @deprecated Deprecated {@link DerivedType} subclass.
+ */
+@Deprecated
 class DerivedIntegerType extends DerivedType<IntegerTypeDefinition> implements IntegerTypeDefinition {
 
     public DerivedIntegerType(final ExtendedType definition) {
diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedLeafrefType.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedLeafrefType.java
index aca0f053fb..8588374086 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedLeafrefType.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedLeafrefType.java
@@ -10,6 +10,10 @@ package org.opendaylight.yangtools.yang.model.util;
 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
 
+/**
+ * @deprecated Deprecated {@link DerivedType} subclass.
+ */
+@Deprecated
 class DerivedLeafrefType extends DerivedType<LeafrefTypeDefinition> implements LeafrefTypeDefinition {
 
     public DerivedLeafrefType(final ExtendedType definition) {
diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedStringType.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedStringType.java
index 08c0ac785f..61e6d6e707 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedStringType.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedStringType.java
@@ -12,6 +12,10 @@ 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.StringTypeDefinition;
 
+/**
+ * @deprecated Deprecated {@link DerivedType} subclass.
+ */
+@Deprecated
 class DerivedStringType extends DerivedType<StringTypeDefinition> implements StringTypeDefinition {
 
     public DerivedStringType(final ExtendedType definition) {
diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedUnionType.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedUnionType.java
index f65230930d..8d22376345 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedUnionType.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedUnionType.java
@@ -11,6 +11,10 @@ import java.util.List;
 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
 
+/**
+ * @deprecated Deprecated {@link DerivedType} subclass.
+ */
+@Deprecated
 class DerivedUnionType extends DerivedType<UnionTypeDefinition> implements UnionTypeDefinition {
 
     public DerivedUnionType(final ExtendedType definition) {
diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedUnsignedIntegerType.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedUnsignedIntegerType.java
index 9ee267fb2a..6fbe34f683 100644
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedUnsignedIntegerType.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DerivedUnsignedIntegerType.java
@@ -11,6 +11,10 @@ import java.util.List;
 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
 import org.opendaylight.yangtools.yang.model.api.type.UnsignedIntegerTypeDefinition;
 
+/**
+ * @deprecated Deprecated {@link DerivedType} subclass.
+ */
+@Deprecated
 class DerivedUnsignedIntegerType extends DerivedType<UnsignedIntegerTypeDefinition> implements
         UnsignedIntegerTypeDefinition {
 
-- 
2.36.6