Migrate mdsal-binding-dom-adapter to JDT annotations
authorRobert Varga <robert.varga@pantheon.tech>
Mon, 8 Oct 2018 13:29:40 +0000 (15:29 +0200)
committerAnil Belur <abelur@linuxfoundation.org>
Wed, 19 Jun 2024 00:41:25 +0000 (10:41 +1000)
This removes the use of javax.annotation nullable annotations
to remove import-package.

Change-Id: I220ed55636d3a4a4bc3e4c39a6169541f89cf283
JIRA: MDSAL-373
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/AbstractBigRangeGenerator.java
binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/AbstractPrimitiveRangeGenerator.java
binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/AbstractRangeGenerator.java
binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/LengthGenerator.java
binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/TypeUtils.java

index c55694048cf994841f2db0a47cd4a7ebd8686a42..0e1394231d28804e7b92ed1301f53a03d924882c 100644 (file)
@@ -11,7 +11,6 @@ import com.google.common.collect.Range;
 import java.lang.reflect.Array;
 import java.util.Set;
 import java.util.function.Function;
-import javax.annotation.Nonnull;
 import org.opendaylight.yangtools.yang.binding.CodeHelpers;
 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
 
@@ -42,7 +41,7 @@ abstract class AbstractBigRangeGenerator<T extends Number & Comparable<T>> exten
 
     @Override
     protected final String generateRangeCheckerImplementation(final String checkerName,
-            @Nonnull final RangeConstraint<?> constraint, final Function<Class<?>, String> classImporter) {
+            final RangeConstraint<?> constraint, final Function<Class<?>, String> classImporter) {
         final Set<? extends Range<? extends Number>> constraints = constraint.getAllowedRanges().asRanges();
         final String fieldName = checkerName.toUpperCase() + "_RANGES";
         final StringBuilder sb = new StringBuilder();
index d57f00daaee50cbe7d131a9b0ccfc8e1ba84a86f..96e02993c8a5f9037a9c8b858cd37f1716c09317 100644 (file)
@@ -7,14 +7,15 @@
  */
 package org.opendaylight.mdsal.binding.java.api.generator;
 
-import com.google.common.base.Preconditions;
+import static java.util.Objects.requireNonNull;
+
 import com.google.common.collect.Range;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
 import java.util.Set;
 import java.util.function.Function;
-import javax.annotation.Nonnull;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.binding.CodeHelpers;
 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
 import org.slf4j.Logger;
@@ -26,11 +27,12 @@ abstract class AbstractPrimitiveRangeGenerator<T extends Number & Comparable<T>>
     private final T minValue;
     private final T maxValue;
 
-    protected AbstractPrimitiveRangeGenerator(final Class<T> typeClass, final String primitiveName, final T minValue, final T maxValue) {
+    protected AbstractPrimitiveRangeGenerator(final Class<T> typeClass, final String primitiveName, final T minValue,
+            final T maxValue) {
         super(typeClass);
-        this.primitiveName = Preconditions.checkNotNull(primitiveName);
-        this.minValue = Preconditions.checkNotNull(minValue);
-        this.maxValue = Preconditions.checkNotNull(maxValue);
+        this.primitiveName = requireNonNull(primitiveName);
+        this.minValue = requireNonNull(minValue);
+        this.maxValue = requireNonNull(maxValue);
     }
 
     /**
@@ -38,7 +40,7 @@ abstract class AbstractPrimitiveRangeGenerator<T extends Number & Comparable<T>>
      *
      * @return Primitive type name
      */
-    @Nonnull protected final String getPrimitiveName() {
+    protected final @NonNull String getPrimitiveName() {
         return primitiveName;
     }
 
index e5c09346be472e1a2f7b610ef588130fc83d15ac..45c2973dbdd87c5993f5ef739a9e7cbed196a42d 100644 (file)
@@ -7,12 +7,13 @@
  */
 package org.opendaylight.mdsal.binding.java.api.generator;
 
-import com.google.common.base.Preconditions;
+import static java.util.Objects.requireNonNull;
+
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableMap.Builder;
 import java.util.Map;
 import java.util.function.Function;
-import javax.annotation.Nonnull;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.mdsal.binding.model.api.ConcreteType;
 import org.opendaylight.mdsal.binding.model.api.Type;
 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
@@ -23,7 +24,8 @@ abstract class AbstractRangeGenerator<T extends Number & Comparable<T>> {
     private static final Logger LOG = LoggerFactory.getLogger(AbstractRangeGenerator.class);
     private static final Map<String, AbstractRangeGenerator<?>> GENERATORS;
 
-    private static void addGenerator(final Builder<String, AbstractRangeGenerator<?>> b, final AbstractRangeGenerator<?> generator) {
+    private static void addGenerator(final Builder<String, AbstractRangeGenerator<?>> b,
+            final AbstractRangeGenerator<?> generator) {
         b.put(generator.getTypeClass().getCanonicalName(), generator);
     }
 
@@ -41,10 +43,10 @@ abstract class AbstractRangeGenerator<T extends Number & Comparable<T>> {
     private final Class<T> type;
 
     protected AbstractRangeGenerator(final Class<T> typeClass) {
-        this.type = Preconditions.checkNotNull(typeClass);
+        this.type = requireNonNull(typeClass);
     }
 
-    static AbstractRangeGenerator<?> forType(@Nonnull final Type type) {
+    static AbstractRangeGenerator<?> forType(final @NonNull Type type) {
         final ConcreteType javaType = TypeUtils.getBaseYangType(type);
         return GENERATORS.get(javaType.getFullyQualifiedName());
     }
@@ -54,7 +56,7 @@ abstract class AbstractRangeGenerator<T extends Number & Comparable<T>> {
      *
      * @return A class object
      */
-    @Nonnull protected final Class<T> getTypeClass() {
+    protected final @NonNull Class<T> getTypeClass() {
         return type;
     }
 
@@ -63,7 +65,7 @@ abstract class AbstractRangeGenerator<T extends Number & Comparable<T>> {
      *
      * @return Fully-qualified name
      */
-    @Nonnull protected final String getTypeName() {
+    protected final @NonNull String getTypeName() {
         return type.getName();
     }
 
@@ -73,7 +75,7 @@ abstract class AbstractRangeGenerator<T extends Number & Comparable<T>> {
      * @param value Value as a Number
      * @return Value in native format.
      */
-    @Nonnull protected final T getValue(final Number value) {
+    protected final @NonNull T getValue(final Number value) {
         if (type.isInstance(value)) {
             return type.cast(value);
         }
@@ -103,7 +105,7 @@ abstract class AbstractRangeGenerator<T extends Number & Comparable<T>> {
      * @param value Number value
      * @return Java language string representation
      */
-    @Nonnull protected abstract String format(T value);
+    protected abstract @NonNull String format(T value);
 
     /**
      * Generate the checker method source code.
@@ -111,19 +113,19 @@ abstract class AbstractRangeGenerator<T extends Number & Comparable<T>> {
      * @param constraints Restrictions which need to be applied.
      * @return Method source code.
      */
-    @Nonnull protected abstract String generateRangeCheckerImplementation(@Nonnull String checkerName,
-            @Nonnull RangeConstraint<?> constraints, Function<Class<?>, String> classImporter);
+    protected abstract @NonNull String generateRangeCheckerImplementation(@NonNull String checkerName,
+            @NonNull RangeConstraint<?> constraints, Function<Class<?>, String> classImporter);
 
     private static String rangeCheckerName(final String member) {
         return "check" + member + "Range";
     }
 
-    String generateRangeChecker(@Nonnull final String member, @Nonnull final RangeConstraint<?> constraints,
+    String generateRangeChecker(final @NonNull String member, final @NonNull RangeConstraint<?> constraints,
             final JavaFileTemplate template) {
         return generateRangeCheckerImplementation(rangeCheckerName(member), constraints, template::importedName);
     }
 
-    String generateRangeCheckerCall(@Nonnull final String member, @Nonnull final String valueReference) {
+    String generateRangeCheckerCall(final @NonNull String member, final @NonNull String valueReference) {
         return rangeCheckerName(member) + '(' + valueReference + ");\n";
     }
 }
index 0f98ae9472c75b7cd2fee18e4fad49df55b823ed..b465c55873e7b1c596a488775fcebf90c5640ff8 100644 (file)
@@ -11,8 +11,8 @@ import com.google.common.collect.Range;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Set;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
 import org.opendaylight.mdsal.binding.model.api.Type;
 import org.opendaylight.yangtools.yang.binding.CodeHelpers;
 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
@@ -122,7 +122,7 @@ final class LengthGenerator {
                         : generateStringLengthChecker(member, constraint, template);
     }
 
-    static String generateLengthCheckerCall(@Nullable final String member, @Nonnull final String valueReference) {
+    static String generateLengthCheckerCall(final @Nullable String member, final @NonNull String valueReference) {
         return lengthCheckerName(member) + '(' + valueReference + ");\n";
     }
 }
index 251fa48c6fcd380ceacd4c44b21f36c84b88fb07..bbb2d22b62496153d5d4bbdac6523ba2073693d6 100644 (file)
@@ -7,8 +7,9 @@
  */
 package org.opendaylight.mdsal.binding.java.api.generator;
 
-import com.google.common.base.Preconditions;
-import javax.annotation.Nonnull;
+import static com.google.common.base.Preconditions.checkArgument;
+
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.mdsal.binding.model.api.ConcreteType;
 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty;
 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
@@ -31,13 +32,13 @@ final class TypeUtils {
      * @param type Input Type object
      * @return Resolved {@link ConcreteType} instance.
      */
-    static ConcreteType getBaseYangType(@Nonnull final Type type) {
+    static ConcreteType getBaseYangType(final @NonNull Type type) {
         // Already the correct type
         if (type instanceof ConcreteType) {
             return (ConcreteType) type;
         }
 
-        Preconditions.checkArgument(type instanceof GeneratedTransferObject, "Unsupported type %s", type);
+        checkArgument(type instanceof GeneratedTransferObject, "Unsupported type %s", type);
 
         // Need to walk up the GTO chain to the root
         GeneratedTransferObject rootGto = (GeneratedTransferObject) type;