Continued to refactor the Metapath runtime exception hierarchy. Created a RuntimeMetapathError exception class that all runtime exceptions are now children of. Moved function-related exceptions to their own branch in the Metapath runtime error tree.

Author: david-waltermire

core/src/main/java/gov/nist/secauto/metaschema/core/metapath/DynamicMetapathError.java

@@ -6,24 +6,18 @@
 package gov.nist.secauto.metaschema.core.metapath;
 
 import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
 
 /**
  * This Metapath exception base class is used for all exceptions that have a
  * defined error code family and value.
  */
 public class DynamicMetapathError
-    extends MetapathException {
+    extends RuntimeMetapathError {
 
   /**
    * the serial version UID.
    */
   private static final long serialVersionUID = 1L;
-  /**
-   * The error prefix which identifies what kind of error it is.
-   */
-  @NonNull
-  private final IErrorCode errorCode;
 
   /**
    * Constructs a new Metapath exception with the provided {@code code},
@@ -35,8 +29,7 @@ public class DynamicMetapathError
    *          the exception message
    */
   public DynamicMetapathError(@NonNull IErrorCode errorCode, String message) {
-    super(message);
-    this.errorCode = errorCode;
+    super(errorCode, message);
   }
 
   /**
@@ -51,8 +44,7 @@ public DynamicMetapathError(@NonNull IErrorCode errorCode, String message) {
    *          the original exception cause
    */
   protected DynamicMetapathError(@NonNull IErrorCode errorCode, String message, Throwable cause) {
-    super(message, cause);
-    this.errorCode = errorCode;
+    super(errorCode, message, cause);
   }
 
   /**
@@ -65,32 +57,6 @@ protected DynamicMetapathError(@NonNull IErrorCode errorCode, String message, Th
    *          the original exception cause
    */
   public DynamicMetapathError(@NonNull IErrorCode errorCode, Throwable cause) {
-    super(cause);
-    this.errorCode = errorCode;
-  }
-
-  @Override
-  public final String getMessage() {
-    String message = getMessageText();
-    return String.format("%s%s", getErrorCode().toString(), message == null ? "" : ": " + message);
-  }
-
-  /**
-   * Get the message text without the error code prefix.
-   *
-   * @return the message text or {@code null}
-   */
-  @Nullable
-  public final String getMessageText() {
-    return super.getMessage();
-  }
-
-  /**
-   * Get the error code, which indicates what type of error it is.
-   *
-   * @return the error code
-   */
-  public final IErrorCode getErrorCode() {
-    return errorCode;
+    super(errorCode, cause);
   }
 }

core/src/main/java/gov/nist/secauto/metaschema/core/metapath/IMetapathExpression.java

@@ -14,7 +14,7 @@
 import gov.nist.secauto.metaschema.core.metapath.item.atomic.IAnyAtomicItem;
 import gov.nist.secauto.metaschema.core.metapath.item.atomic.INumericItem;
 import gov.nist.secauto.metaschema.core.metapath.type.InvalidTypeMetapathException;
-import gov.nist.secauto.metaschema.core.metapath.type.TypeMetapathException;
+import gov.nist.secauto.metaschema.core.metapath.type.TypeMetapathError;
 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
 
 import java.math.BigDecimal;
@@ -82,7 +82,7 @@ public Class<?> expectedClass() {
      * @param sequence
      *          the Metapath result sequence to convert
      * @return the converted sequence as the expected type
-     * @throws TypeMetapathException
+     * @throws TypeMetapathError
      *           if the provided sequence is incompatible with the expected result
      *           type
      */
@@ -113,7 +113,7 @@ interface ConversionFunction {
    */
   @NonNull
   static IMetapathExpression contextNode() {
-    return MetapathExpression.CONTEXT_NODE;
+    return MetapathExpression.CONTEXT_METAPATH;
   }
 
   /**
@@ -127,7 +127,7 @@ static IMetapathExpression contextNode() {
    */
   @NonNull
   static IMetapathExpression compile(@NonNull String path) {
-    return MetapathExpression.compile(path, StaticContext.instance());
+    return compile(path, StaticContext.instance());
   }
 
   /**
@@ -188,7 +188,7 @@ static IMetapathExpression lazyCompile(@NonNull String path, @NonNull StaticCont
    * @param resultType
    *          the type of result to produce
    * @return the converted result
-   * @throws TypeMetapathException
+   * @throws TypeMetapathError
    *           if the provided sequence is incompatible with the requested result
    *           type
    * @throws MetapathException
@@ -212,7 +212,7 @@ default <T> T evaluateAs(@NonNull ResultType resultType) {
    * @param resultType
    *          the type of result to produce
    * @return the converted result
-   * @throws TypeMetapathException
+   * @throws TypeMetapathError
    *           if the provided sequence is incompatible with the requested result
    *           type
    * @throws MetapathException
@@ -243,7 +243,7 @@ default <T> T evaluateAs(
    * @param dynamicContext
    *          the dynamic context to use for evaluation
    * @return the converted result
-   * @throws TypeMetapathException
+   * @throws TypeMetapathError
    *           if the provided sequence is incompatible with the requested result
    *           type
    * @throws MetapathException

core/src/main/java/gov/nist/secauto/metaschema/core/metapath/RuntimeMetapathError.java

@@ -0,0 +1,93 @@
+/*
+ * SPDX-FileCopyrightText: none
+ * SPDX-License-Identifier: CC0-1.0
+ */
+
+package gov.nist.secauto.metaschema.core.metapath;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+import edu.umd.cs.findbugs.annotations.Nullable;
+
+public class RuntimeMetapathError
+    extends MetapathException {
+
+  /**
+   * the serial version UID.
+   */
+  private static final long serialVersionUID = 1L;
+  /**
+   * The error prefix which identifies what kind of error it is.
+   */
+  @NonNull
+  private final IErrorCode errorCode;
+
+  /**
+   * Constructs a new Metapath exception with the provided {@code code},
+   * {@code message}, and no cause.
+   *
+   * @param errorCode
+   *          the error code that identifies the type of error
+   * @param message
+   *          the exception message
+   */
+  // TODO: Make protected?
+  public RuntimeMetapathError(@NonNull IErrorCode errorCode, String message) {
+    super(message);
+    this.errorCode = errorCode;
+  }
+
+  /**
+   * Constructs a new Metapath exception with the provided {@code code},
+   * {@code message}, and {@code cause}.
+   *
+   * @param errorCode
+   *          the error code that identifies the type of error
+   * @param message
+   *          the exception message
+   * @param cause
+   *          the original exception cause
+   */
+  public RuntimeMetapathError(@NonNull IErrorCode errorCode, String message, Throwable cause) {
+    super(message, cause);
+    this.errorCode = errorCode;
+  }
+
+  /**
+   * Constructs a new Metapath exception with a {@code null} message and the
+   * provided {@code cause}.
+   *
+   * @param errorCode
+   *          the error code that identifies the type of error
+   * @param cause
+   *          the original exception cause
+   */
+  public RuntimeMetapathError(@NonNull IErrorCode errorCode, Throwable cause) {
+    super(cause);
+    this.errorCode = errorCode;
+  }
+
+  @Override
+  public final String getMessage() {
+    String message = getMessageText();
+    return String.format("%s%s", getErrorCode().toString(), message == null ? "" : ": " + message);
+  }
+
+  /**
+   * Get the message text without the error code prefix.
+   *
+   * @return the message text or {@code null}
+   */
+  @Nullable
+  public final String getMessageText() {
+    return super.getMessage();
+  }
+
+  /**
+   * Get the error code, which indicates what type of error it is.
+   *
+   * @return the error code
+   */
+  public final IErrorCode getErrorCode() {
+    return errorCode;
+  }
+}

core/src/main/java/gov/nist/secauto/metaschema/core/metapath/StaticContext.java

@@ -463,7 +463,7 @@ public IFunction lookupFunction(@NonNull String name, int arity) {
    * @param qname
    *          the qualified name of the function
    * @param arity
-   *          the number of arguments <<<<<<< HEAD
+   *          the number of arguments
    * @return the function
    * @throws StaticMetapathError
    *           with the code {@link StaticMetapathError#NO_FUNCTION_MATCH} if a

core/src/main/java/gov/nist/secauto/metaschema/core/metapath/StaticMetapathError.java

@@ -6,15 +6,14 @@
 package gov.nist.secauto.metaschema.core.metapath;
 
 import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
 
 /**
  * MPST: Exceptions related to the Metapath static context and static
  * evaluation.
  */
 @SuppressWarnings("PMD.DataClass")
 public class StaticMetapathError
-    extends MetapathException {
+    extends RuntimeMetapathError {
   @NonNull
   private static final String PREFIX = "MPST";
   /**
@@ -125,11 +124,6 @@ public class StaticMetapathError
    * the serial version UID.
    */
   private static final long serialVersionUID = 2L;
-  /**
-   * The error prefix which identifies what kind of error it is.
-   */
-  @NonNull
-  private final IErrorCode errorCode;
 
   /**
    * Constructs a new exception with the provided {@code code}, {@code message},
@@ -143,23 +137,7 @@ public class StaticMetapathError
    *          the original exception cause
    */
   public StaticMetapathError(int code, String message, Throwable cause) {
-    this(IErrorCode.of(PREFIX, code), message, cause);
-  }
-
-  /**
-   * Constructs a new exception with the provided {@code code}, {@code message},
-   * and {@code cause}.
-   *
-   * @param errorCode
-   *          the error code
-   * @param message
-   *          the exception message
-   * @param cause
-   *          the original exception cause
-   */
-  public StaticMetapathError(@NonNull IErrorCode errorCode, String message, Throwable cause) {
-    super(message, cause);
-    this.errorCode = errorCode;
+    super(IErrorCode.of(PREFIX, code), message, cause);
   }
 
   /**
@@ -172,8 +150,7 @@ public StaticMetapathError(@NonNull IErrorCode errorCode, String message, Throwa
    *          the exception message
    */
   public StaticMetapathError(int code, String message) {
-    super(message);
-    this.errorCode = IErrorCode.of(PREFIX, code);
+    super(IErrorCode.of(PREFIX, code), message);
   }
 
   /**
@@ -186,32 +163,6 @@ public StaticMetapathError(int code, String message) {
    *          the original exception cause
    */
   public StaticMetapathError(int code, Throwable cause) {
-    super(cause);
-    this.errorCode = IErrorCode.of(PREFIX, code);
-  }
-
-  @Override
-  public final String getMessage() {
-    String message = getMessageText();
-    return String.format("%s%s", getErrorCode().toString(), message == null ? "" : ": " + message);
-  }
-
-  /**
-   * Get the message text without the error code prefix.
-   *
-   * @return the message text or {@code null}
-   */
-  @Nullable
-  public final String getMessageText() {
-    return super.getMessage();
-  }
-
-  /**
-   * Get the error code, which indicates what type of error it is.
-   *
-   * @return the error code
-   */
-  public final IErrorCode getErrorCode() {
-    return errorCode;
+    super(IErrorCode.of(PREFIX, code), cause);
   }
 }

core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/ArithmeticFunctionException.java

@@ -5,7 +5,6 @@
 
 package gov.nist.secauto.metaschema.core.metapath.function;
 
-import gov.nist.secauto.metaschema.core.metapath.DynamicMetapathError;
 import gov.nist.secauto.metaschema.core.metapath.IErrorCode;
 
 import edu.umd.cs.findbugs.annotations.NonNull;
@@ -14,7 +13,7 @@
  * Represents an error that occurred while performing mathematical operations.
  */
 public class ArithmeticFunctionException
-    extends DynamicMetapathError {
+    extends FunctionMetapathError {
   @NonNull
   private static final String PREFIX = "FOAR";
   /**

core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/CastFunctionException.java

@@ -5,7 +5,6 @@
 
 package gov.nist.secauto.metaschema.core.metapath.function;
 
-import gov.nist.secauto.metaschema.core.metapath.DynamicMetapathError;
 import gov.nist.secauto.metaschema.core.metapath.IErrorCode;
 import gov.nist.secauto.metaschema.core.metapath.item.atomic.IAnyAtomicItem;
 
@@ -15,7 +14,7 @@
  * FOCA: Exceptions related to type casting.
  */
 public class CastFunctionException
-    extends DynamicMetapathError {
+    extends FunctionMetapathError {
   @NonNull
   private static final String PREFIX = "FOCA";
   /**

core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/DateTimeFunctionException.java

@@ -5,7 +5,6 @@
 
 package gov.nist.secauto.metaschema.core.metapath.function;
 
-import gov.nist.secauto.metaschema.core.metapath.DynamicMetapathError;
 import gov.nist.secauto.metaschema.core.metapath.IErrorCode;
 
 import edu.umd.cs.findbugs.annotations.NonNull;
@@ -14,7 +13,7 @@
  * FODT: Exceptions related to Date/Time/Duration errors.
  */
 public class DateTimeFunctionException
-    extends DynamicMetapathError {
+    extends FunctionMetapathError {
   @NonNull
   private static final String PREFIX = "FODT";
   /**