Migrate SourceException and its subclasses to JDT annotations

This is straightforward change, just switch over annotations and
fixup some of the warnings in the corresponding test.

JIRA: YANGTOOLS-907
Change-Id: I9d757381d71af205f3ed4a41778a2027a66d3fdb
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/InferenceException.java b/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/InferenceException.java
index 6119e51e6d321e87f8c33b9373467fb466181e5e..35f49d0ee8b68b2e29dd510c5a0a4639c5aa44e7 100644 (file)
--- a/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/InferenceException.java
+++ b/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/InferenceException.java
@@ -7,7 +7,7 @@
  */
 package org.opendaylight.yangtools.yang.parser.spi.meta;
 
-import javax.annotation.Nonnull;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
 
@@ -17,16 +17,16 @@ import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReferenc
 public class InferenceException extends SourceException {
     private static final long serialVersionUID = 1L;
 
-    public InferenceException(@Nonnull final String message, @Nonnull final StatementSourceReference source,
+    public InferenceException(final @NonNull String message, final @NonNull StatementSourceReference source,
             final Throwable cause) {
         super(message, source, cause);
     }
 
-    public InferenceException(@Nonnull final String message, @Nonnull final StatementSourceReference source) {
+    public InferenceException(final @NonNull String message, final @NonNull StatementSourceReference source) {
         super(message, source);
     }
 
-    public InferenceException(@Nonnull final StatementSourceReference source, @Nonnull final String format,
+    public InferenceException(final @NonNull StatementSourceReference source, final @NonNull String format,
             final Object... args) {
         this(String.format(format, args), source);
     }
@@ -41,8 +41,8 @@ public class InferenceException extends SourceException {
      * @param args Format string arguments, according to {@link String#format(String, Object...)}
      * @throws InferenceException if the expression evaluates to true.
      */
-    public static void throwIf(final boolean expression, @Nonnull final StatementSourceReference source,
-            @Nonnull final String format, final Object... args) {
+    public static void throwIf(final boolean expression, final @NonNull StatementSourceReference source,
+            final @NonNull String format, final Object... args) {
         if (expression) {
             throw new InferenceException(source, format, args);
         }

diff --git a/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/InvalidSubstatementException.java b/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/InvalidSubstatementException.java
index 99c9c19754f4208de099b209d40c0a3f60ecb46d..9c947166fd9ede351b7f47bcb8bc987b6897f58b 100644 (file)
--- a/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/InvalidSubstatementException.java
+++ b/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/InvalidSubstatementException.java
@@ -7,7 +7,7 @@
  */
 package org.opendaylight.yangtools.yang.parser.spi.meta;
 
-import javax.annotation.Nonnull;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
 
@@ -17,17 +17,16 @@ import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReferenc
 public class InvalidSubstatementException extends SourceException {
     private static final long serialVersionUID = 1L;
 
-    public InvalidSubstatementException(@Nonnull final String message,
-            @Nonnull final StatementSourceReference source) {
+    public InvalidSubstatementException(final @NonNull String message, final @NonNull StatementSourceReference source) {
         super(message, source);
     }
 
-    public InvalidSubstatementException(@Nonnull final String message, @Nonnull final StatementSourceReference source,
+    public InvalidSubstatementException(final @NonNull String message, final @NonNull StatementSourceReference source,
             final Throwable cause) {
         super(message, source, cause);
     }
 
-    public InvalidSubstatementException(@Nonnull final StatementSourceReference source, @Nonnull final String format,
+    public InvalidSubstatementException(final @NonNull StatementSourceReference source, final @NonNull String format,
             final Object... args) {
         this(String.format(format, args), source);
     }

diff --git a/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/MissingSubstatementException.java b/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/MissingSubstatementException.java
index 70b0dcf752cf8ff9f8c46ff533272db8b082405a..4919fb72be837104334af1650626f3c69ae566d8 100644 (file)
--- a/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/MissingSubstatementException.java
+++ b/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/MissingSubstatementException.java
@@ -7,7 +7,7 @@
  */
 package org.opendaylight.yangtools.yang.parser.spi.meta;
 
-import javax.annotation.Nonnull;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
 
@@ -17,17 +17,16 @@ import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReferenc
 public class MissingSubstatementException extends SourceException {
     private static final long serialVersionUID = 1L;
 
-    public MissingSubstatementException(@Nonnull final String message,
-            @Nonnull final StatementSourceReference source) {
+    public MissingSubstatementException(final @NonNull String message, final @NonNull StatementSourceReference source) {
         super(message, source);
     }
 
-    public MissingSubstatementException(@Nonnull final String message, @Nonnull final StatementSourceReference source,
+    public MissingSubstatementException(final @NonNull String message, final @NonNull StatementSourceReference source,
             final Throwable cause) {
         super(message, source, cause);
     }
 
-    public MissingSubstatementException(@Nonnull final StatementSourceReference source, @Nonnull final String format,
+    public MissingSubstatementException(final @NonNull StatementSourceReference source, final @NonNull String format,
             final Object... args) {
         this(String.format(format, args), source);
     }

diff --git a/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/source/SourceException.java b/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/source/SourceException.java
index fba795725b40baa1ff70417c6bd3d417cdc0ff42..ff4c8eb8797115786df9d260b573ac76f8858b46 100644 (file)
--- a/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/source/SourceException.java
+++ b/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/source/SourceException.java
@@ -11,8 +11,8 @@ import static java.util.Objects.requireNonNull;
 
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.util.Optional;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
 
 /**
  * Thrown to indicate error in YANG model source.
@@ -21,7 +21,7 @@ public class SourceException extends RuntimeException {
     private static final long serialVersionUID = 1L;
 
     @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "Interface-specified member")
-    private final StatementSourceReference sourceRef;
+    private final @NonNull StatementSourceReference sourceRef;
 
     /**
      * Create a new instance with the specified message and source. The message will be appended with
@@ -30,7 +30,7 @@ public class SourceException extends RuntimeException {
      * @param message Context message
      * @param source Statement source
      */
-    public SourceException(@Nonnull final String message, @Nonnull final StatementSourceReference source) {
+    public SourceException(final @NonNull String message, final @NonNull StatementSourceReference source) {
         super(createMessage(message, source));
         sourceRef = source;
     }
@@ -43,7 +43,7 @@ public class SourceException extends RuntimeException {
      * @param source Statement source
      * @param cause Underlying cause of this exception
      */
-    public SourceException(@Nonnull final String message, @Nonnull final StatementSourceReference source,
+    public SourceException(final @NonNull String message, final @NonNull StatementSourceReference source,
             final Throwable cause) {
         super(createMessage(message, source), cause);
         sourceRef = source;
@@ -57,7 +57,7 @@ public class SourceException extends RuntimeException {
      * @param format Format string, according to {@link String#format(String, Object...)}.
      * @param args Format string arguments, according to {@link String#format(String, Object...)}
      */
-    public SourceException(@Nonnull final StatementSourceReference source, @Nonnull final String format,
+    public SourceException(final @NonNull StatementSourceReference source, final @NonNull String format,
             final Object... args) {
         this(String.format(format, args), source);
     }
@@ -71,8 +71,8 @@ public class SourceException extends RuntimeException {
      * @param format Format string, according to {@link String#format(String, Object...)}.
      * @param args Format string arguments, according to {@link String#format(String, Object...)}
      */
-    public SourceException(@Nonnull final StatementSourceReference source, final Throwable cause,
-            @Nonnull final String format, final Object... args) {
+    public SourceException(final @NonNull StatementSourceReference source, final Throwable cause,
+            final @NonNull String format, final Object... args) {
         this(String.format(format, args), source, cause);
     }
 
@@ -81,7 +81,7 @@ public class SourceException extends RuntimeException {
      *
      * @return Source reference
      */
-    public @Nonnull StatementSourceReference getSourceReference() {
+    public @NonNull StatementSourceReference getSourceReference() {
         return sourceRef;
     }
 
@@ -95,8 +95,8 @@ public class SourceException extends RuntimeException {
      * @param args Format string arguments, according to {@link String#format(String, Object...)}
      * @throws SourceException if the expression evaluates to true.
      */
-    public static void throwIf(final boolean expression, @Nonnull final StatementSourceReference source,
-            @Nonnull final String format, final Object... args) {
+    public static void throwIf(final boolean expression, final @NonNull StatementSourceReference source,
+            final @NonNull String format, final Object... args) {
         if (expression) {
             throw new SourceException(source, format, args);
         }
@@ -113,9 +113,11 @@ public class SourceException extends RuntimeException {
      * @return Object if it is not null
      * @throws SourceException if object is null
      */
-    @Nonnull public static <T> T throwIfNull(@Nullable final T obj, @Nonnull final StatementSourceReference source,
-            @Nonnull final String format, final Object... args) {
-        throwIf(obj == null, source, format, args);
+    public static <T> @NonNull T throwIfNull(final @Nullable T obj, final @NonNull StatementSourceReference source,
+            final @NonNull String format, final Object... args) {
+        if (obj == null) {
+            throw new SourceException(source, format, args);
+        }
         return obj;
     }
 
@@ -130,16 +132,13 @@ public class SourceException extends RuntimeException {
      * @return Object unwrapped from the opt optional
      * @throws SourceException if the optional is not present
      */
-    @Nonnull public static <T> T unwrap(final Optional<T> opt, @Nonnull final StatementSourceReference source,
-            @Nonnull final String format, final Object... args) {
+    public static <T> @NonNull T unwrap(final Optional<T> opt, final @NonNull StatementSourceReference source,
+            final @NonNull String format, final Object... args) {
         throwIf(!opt.isPresent(), source, format, args);
         return opt.get();
     }
 
-    private static String createMessage(@Nonnull final String message, @Nonnull final StatementSourceReference source) {
-        requireNonNull(message);
-        requireNonNull(source);
-
-        return message + " [at " + source + ']';
+    private static String createMessage(final @NonNull String message, final @NonNull StatementSourceReference source) {
+        return requireNonNull(message) + " [at " + requireNonNull(source) + ']';
     }
 }

diff --git a/yang/yang-parser-spi/src/test/java/org/opendaylight/yangtools/yang/parser/spi/source/SourceExceptionTest.java b/yang/yang-parser-spi/src/test/java/org/opendaylight/yangtools/yang/parser/spi/source/SourceExceptionTest.java
index 6cb96991303c3a27cf24d87ff026ed8b30bb5414..70f2dfb001ae7632d33b1fce445d77ece19a838b 100644 (file)
--- a/yang/yang-parser-spi/src/test/java/org/opendaylight/yangtools/yang/parser/spi/source/SourceExceptionTest.java
+++ b/yang/yang-parser-spi/src/test/java/org/opendaylight/yangtools/yang/parser/spi/source/SourceExceptionTest.java
@@ -27,12 +27,7 @@ public class SourceExceptionTest {
 
     @Test
     public void testThrowIfFalse() {
-        SourceException.throwIf(false, null, null);
-    }
-
-    @Test(expected = NullPointerException.class)
-    public void testThrowIfTrueNullNull() {
-        SourceException.throwIf(true, null, null);
+        SourceException.throwIf(false, mock, "");
     }
 
     @Test(expected = NullPointerException.class)
@@ -57,12 +52,12 @@ public class SourceExceptionTest {
 
     @Test
     public void testThrowIfNullMock() {
-        assertSame(mock, SourceException.throwIfNull(mock, null, null));
+        assertSame(mock, SourceException.throwIfNull(mock, mock, ""));
     }
 
     @Test
     public void testUnwrapPresent() {
-        assertEquals("test", SourceException.unwrap(Optional.of("test"), null, null));
+        assertEquals("test", SourceException.unwrap(Optional.of("test"), mock, ""));
     }
 
     @Test(expected = SourceException.class)