Integrate {Inference,Source}Exception with CommonStmtCtx

[yangtools.git] / yang / yang-parser-spi / src / main / java / org / opendaylight / yangtools / yang / parser / spi / source / SourceException.java

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 4a277d30e04eb58da81b56090cab9abc4a28572a..a0ef7796ef9f260c9137760fc887ab3d76ab4830 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
@@ -13,6 +13,7 @@ import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.util.Optional;
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
 
 /**
  * Thrown to indicate error in YANG model source.
@@ -76,6 +77,56 @@ public class SourceException extends RuntimeException {
         this(String.format(format, args), source, cause);
     }
 
+    /**
+     * Create a new instance with the specified message and source. The message will be appended with the source
+     * reference.
+     *
+     * @param message Context message
+     * @param stmt Statement context, not retained
+     */
+    public SourceException(final @NonNull String message, final @NonNull CommonStmtCtx stmt) {
+        this(message, stmt.sourceReference());
+    }
+
+    /**
+     * Create a new instance with the specified message and source. The message will be appended with
+     * the source reference.
+     *
+     * @param message Context message
+     * @param stmt Statement context, not retained
+     * @param cause Underlying cause of this exception
+     */
+    public SourceException(final @NonNull String message, final @NonNull CommonStmtCtx stmt, final Throwable cause) {
+        this(message, stmt.sourceReference(), cause);
+    }
+
+    /**
+     * Create a new instance with the specified source and a formatted message. The message will be appended with
+     * the source reference.
+     *
+     * @param stmt Statement context, not retained
+     * @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(final @NonNull CommonStmtCtx stmt, final @NonNull String format, final Object... args) {
+        this(stmt.sourceReference(), format, args);
+    }
+
+
+    /**
+     * Create a new instance with the specified source and a formatted message. The message will be appended with
+     * the source reference.
+     *
+     * @param stmt Statement context, not retained
+     * @param cause Underlying cause of this exception
+     * @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(final @NonNull CommonStmtCtx stmt, final Throwable cause,
+            final @NonNull String format, final Object... args) {
+        this(stmt.sourceReference(), cause, format, args);
+    }
+
     /**
      * Return the reference to the source which caused this exception.
      *
@@ -85,6 +136,23 @@ public class SourceException extends RuntimeException {
         return sourceRef;
     }
 
+    /**
+     * Throw an instance of this exception if an expression evaluates to true. If the expression evaluates to false,
+     * this method does nothing.
+     *
+     * @param expression Expression to be evaluated
+     * @param stmt Statement context, not retained
+     * @param format Format string, according to {@link String#format(String, Object...)}.
+     * @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, final @NonNull CommonStmtCtx stmt,
+            final @NonNull String format, final Object... args) {
+        if (expression) {
+            throw new SourceException(stmt, format, args);
+        }
+    }
+
     /**
      * Throw an instance of this exception if an expression evaluates to true. If the expression evaluates to false,
      * this method does nothing.
@@ -121,6 +189,25 @@ public class SourceException extends RuntimeException {
         return obj;
     }
 
+    /**
+     * Throw an instance of this exception if an object is null. If the object is non-null, it will
+     * be returned as the result of this method.
+     *
+     * @param obj Object reference to be checked
+     * @param stmt Statement context, not retained
+     * @param format Format string, according to {@link String#format(String, Object...)}.
+     * @param args Format string arguments, according to {@link String#format(String, Object...)}
+     * @return Object if it is not null
+     * @throws SourceException if object is null
+     */
+    public static <T> @NonNull T throwIfNull(final @Nullable T obj, final @NonNull CommonStmtCtx stmt,
+            final @NonNull String format, final Object... args) {
+        if (obj == null) {
+            throw new SourceException(stmt.sourceReference(), format, args);
+        }
+        return obj;
+    }
+
     /**
      * Throw an instance of this exception if an optional is not present. If it is present, this method will return
      * the unwrapped value.
@@ -138,6 +225,23 @@ public class SourceException extends RuntimeException {
         return opt.get();
     }
 
+    /**
+     * Throw an instance of this exception if an optional is not present. If it is present, this method will return
+     * the unwrapped value.
+     *
+     * @param opt Optional to be checked
+     * @param stmt Statement context, not retained
+     * @param format Format string, according to {@link String#format(String, Object...)}.
+     * @param args Format string arguments, according to {@link String#format(String, Object...)}
+     * @return Object unwrapped from the opt optional
+     * @throws SourceException if the optional is not present
+     */
+    public static <T> @NonNull T unwrap(final Optional<T> opt, final @NonNull CommonStmtCtx stmt,
+            final @NonNull String format, final Object... args) {
+        throwIf(opt.isEmpty(), stmt, format, args);
+        return opt.get();
+    }
+
     private static String createMessage(final @NonNull String message, final @NonNull StatementSourceReference source) {
         return requireNonNull(message) + " [at " + requireNonNull(source) + ']';
     }