Adjust function names to use a static name value.

metaschema-framework · Oct 7, 2024 · 3e5c629 · 3e5c629
1 parent 0e117da
commit 3e5c629
Show file tree

Hide file tree

Showing 23 changed files with 123 additions and 122 deletions.
diff --git a/...src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayAppend.java b/...src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayAppend.java
@@ -22,9 +22,10 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 public final class ArrayAppend {
+  private static final String NAME = "append";
   @NonNull
   static final IFunction SIGNATURE = IFunction.builder()
-      .name("append")
+      .name(NAME)
       .namespace(MetapathConstants.NS_METAPATH_FUNCTIONS_ARRAY)
       .deterministic()
       .contextIndependent()
@@ -56,14 +57,15 @@ private static <T extends ICollectionValue> ISequence<IArrayItem<T>> execute(@No
       IItem focus) {
     IArrayItem<T> array = FunctionUtils.asType(ObjectUtils.requireNonNull(
         arguments.get(0).getFirstItem(true)));
-    @SuppressWarnings("unchecked") T appendage = (T) arguments.get(1).toCollectionValue();
+    @SuppressWarnings("unchecked")
+    T appendage = (T) arguments.get(1).toCollectionValue();
 
     return ISequence.of(append(array, appendage));
   }
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-append">array:append</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-append">array:append</a>.
    *
    * @param <T>
    *          the type of items in the given Metapath array

diff --git a/...rc/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayFlatten.java b/...rc/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayFlatten.java
@@ -20,9 +20,10 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 public final class ArrayFlatten {
+  private static final String NAME = "flatten";
   @NonNull
   static final IFunction SIGNATURE = IFunction.builder()
-      .name("flatten")
+      .name(NAME)
       .namespace(MetapathConstants.NS_METAPATH_FUNCTIONS_ARRAY)
       .deterministic()
       .contextIndependent()
@@ -53,8 +54,8 @@ private static ISequence<?> execute(@NonNull IFunction function,
   }
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-flatten">array:flatten</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-flatten">array:flatten</a>.
    *
    * @param items
    *          the items to flatten
@@ -68,8 +69,8 @@ public static Stream<IItem> flatten(@NonNull List<? extends IItem> items) {
   }
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-flatten">array:flatten</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-flatten">array:flatten</a>.
    *
    * @param item
    *          the item to flatten

diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayGet.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayGet.java
@@ -23,9 +23,10 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 public final class ArrayGet {
+  private static final String NAME = "get";
   @NonNull
   static final IFunction SIGNATURE = IFunction.builder()
-      .name("get")
+      .name(NAME)
       .namespace(MetapathConstants.NS_METAPATH_FUNCTIONS_ARRAY)
       .deterministic()
       .contextIndependent()
@@ -62,8 +63,8 @@ private static ISequence<?> execute(@NonNull IFunction function,
   }
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-get">array:get</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-get">array:get</a>.
    *
    * @param <T>
    *          the type of items in the given Metapath array
@@ -83,8 +84,8 @@ public static <T extends ICollectionValue> T get(
   }
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-get">array:get</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-get">array:get</a>.
    *
    * @param <T>
    *          the type of items in the given Metapath array

diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayHead.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayHead.java
@@ -22,9 +22,10 @@
 import edu.umd.cs.findbugs.annotations.Nullable;
 
 public final class ArrayHead {
+  private static final String NAME = "head";
   @NonNull
   static final IFunction SIGNATURE = IFunction.builder()
-      .name("head")
+      .name(NAME)
       .namespace(MetapathConstants.NS_METAPATH_FUNCTIONS_ARRAY)
       .deterministic()
       .contextIndependent()
@@ -56,8 +57,8 @@ private static ISequence<?> execute(@NonNull IFunction function,
   }
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-head">array:head</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-head">array:head</a>.
    *
    * @param <T>
    *          the type of items in the given Metapath array

diff --git a/...in/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayInsertBefore.java b/...in/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayInsertBefore.java
@@ -23,9 +23,10 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 public final class ArrayInsertBefore {
+  private static final String NAME = "insert-before";
   @NonNull
   static final IFunction SIGNATURE = IFunction.builder()
-      .name("insert-before")
+      .name(NAME)
       .namespace(MetapathConstants.NS_METAPATH_FUNCTIONS_ARRAY)
       .deterministic()
       .contextIndependent()
@@ -63,7 +64,8 @@ private static <T extends ICollectionValue> ISequence<IArrayItem<T>> execute(@No
     IArrayItem<T> array = FunctionUtils.asType(ObjectUtils.requireNonNull(
         arguments.get(0).getFirstItem(true)));
     IIntegerItem position = FunctionUtils.asType(ObjectUtils.requireNonNull(arguments.get(1).getFirstItem(true)));
-    @SuppressWarnings("unchecked") T member = (T) ObjectUtils.requireNonNull(arguments.get(2)).toCollectionValue();
+    @SuppressWarnings("unchecked")
+    T member = (T) ObjectUtils.requireNonNull(arguments.get(2)).toCollectionValue();
 
     return ISequence.of(insertBefore(array, position, member));
   }

diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayJoin.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayJoin.java
@@ -23,9 +23,10 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 public final class ArrayJoin {
+  private static final String NAME = "join";
   @NonNull
   static final IFunction SIGNATURE = IFunction.builder()
-      .name("join")
+      .name(NAME)
       .namespace(MetapathConstants.NS_METAPATH_FUNCTIONS_ARRAY)
       .deterministic()
       .contextIndependent()
@@ -56,8 +57,8 @@ private static <T extends ICollectionValue> ISequence<? extends IArrayItem<T>> e
   }
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-join">array:join</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-join">array:join</a>.
    *
    * @param <T>
    *          the type of items in the given Metapath array

diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayPut.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayPut.java
@@ -24,9 +24,10 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 public final class ArrayPut {
+  private static final String NAME = "put";
   @NonNull
   static final IFunction SIGNATURE = IFunction.builder()
-      .name("put")
+      .name(NAME)
       .namespace(MetapathConstants.NS_METAPATH_FUNCTIONS_ARRAY)
       .deterministic()
       .contextIndependent()
@@ -64,14 +65,15 @@ private static <T extends ICollectionValue> ISequence<? extends IArrayItem<T>> e
     IArrayItem<T> array = FunctionUtils.asType(ObjectUtils.requireNonNull(
         arguments.get(0).getFirstItem(true)));
     IIntegerItem position = FunctionUtils.asType(ObjectUtils.requireNonNull(arguments.get(1).getFirstItem(true)));
-    @SuppressWarnings("unchecked") T member = (T) arguments.get(2).toCollectionValue();
+    @SuppressWarnings("unchecked")
+    T member = (T) arguments.get(2).toCollectionValue();
 
     return put(array, position, member).asSequence();
   }
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-put">array:put</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-put">array:put</a>.
    *
    * @param <T>
    *          the type of items in the given Metapath array
@@ -94,8 +96,8 @@ public static <T extends ICollectionValue> IArrayItem<T> put(
   }
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-put">array:put</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-put">array:put</a>.
    *
    * @param <T>
    *          the type of items in the given Metapath array

diff --git a/...src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayRemove.java b/...src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayRemove.java
@@ -27,9 +27,10 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 public final class ArrayRemove {
+  private static final String NAME = "remove";
   @NonNull
   static final IFunction SIGNATURE = IFunction.builder()
-      .name("remove")
+      .name(NAME)
       .namespace(MetapathConstants.NS_METAPATH_FUNCTIONS_ARRAY)
       .deterministic()
       .contextIndependent()
@@ -67,8 +68,8 @@ private static <T extends IItem> ISequence<IArrayItem<T>> execute(@NonNull IFunc
   }
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-remove">array:remove</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-remove">array:remove</a>.
    *
    * @param <T>
    *          the type of items in the given Metapath array
@@ -92,8 +93,8 @@ public static <T extends IItem> IArrayItem<T> removeItems(
   }
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-remove">array:remove</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-remove">array:remove</a>.
    *
    * @param <T>
    *          the type of items in the given Metapath array

diff --git a/...rc/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayReverse.java b/...rc/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayReverse.java
@@ -23,9 +23,10 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 public final class ArrayReverse {
+  private static final String NAME = "reverse";
   @NonNull
   static final IFunction SIGNATURE = IFunction.builder()
-      .name("reverse")
+      .name(NAME)
       .namespace(MetapathConstants.NS_METAPATH_FUNCTIONS_ARRAY)
       .deterministic()
       .contextIndependent()
@@ -57,8 +58,8 @@ private static <T extends ICollectionValue> ISequence<IArrayItem<T>> execute(@No
   }
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-reverse">array:reverse</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-reverse">array:reverse</a>.
    *
    * @param <T>
    *          the type of items in the given Metapath array

diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArraySize.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArraySize.java
@@ -21,9 +21,10 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 public final class ArraySize {
+  private static final String NAME = "size";
   @NonNull
   static final IFunction SIGNATURE = IFunction.builder()
-      .name("size")
+      .name(NAME)
       .namespace(MetapathConstants.NS_METAPATH_FUNCTIONS_ARRAY)
       .deterministic()
       .contextIndependent()
@@ -39,8 +40,8 @@ public final class ArraySize {
       .build();
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-size">array:size</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-size">array:size</a>.
    *
    * @param array
    *          the arrays to join

diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayTail.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/ArrayTail.java
@@ -21,9 +21,10 @@
 import edu.umd.cs.findbugs.annotations.Nullable;
 
 public final class ArrayTail {
+  private static final String NAME = "tail";
   @NonNull
   static final IFunction SIGNATURE = IFunction.builder()
-      .name("tail")
+      .name(NAME)
       .namespace(MetapathConstants.NS_METAPATH_FUNCTIONS_ARRAY)
       .deterministic()
       .contextIndependent()
@@ -54,8 +55,8 @@ private static <T extends IItem> ISequence<IArrayItem<T>> execute(@NonNull IFunc
   }
 
   /**
-   * An implementation of XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-array-tail">array:tail</a>.
+   * An implementation of XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-array-tail">array:tail</a>.
    *
    * @param <T>
    *          the type of items in the given Metapath array

diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/FnBoolean.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/FnBoolean.java
@@ -26,9 +26,10 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 public final class FnBoolean {
+  private static final String NAME = "boolean";
   @NonNull
   static final IFunction SIGNATURE = IFunction.builder()
-      .name("boolean")
+      .name(NAME)
       .namespace(MetapathConstants.NS_METAPATH_FUNCTIONS)
       .deterministic()
       .contextIndependent()
@@ -63,9 +64,8 @@ private static ISequence<IBooleanItem> execute(@NonNull IFunction function,
   /**
    * Get the effective boolean value of the provided sequence.
    * <p>
-   * Based on the XPath 3.1 <a href=
-   * "https://www.w3.org/TR/xpath-functions-31/#func-boolean">fn:boolean</a>
-   * function.
+   * Based on the XPath 3.1
+   * <a href= "https://www.w3.org/TR/xpath-functions-31/#func-boolean">fn:boolean</a> function.
    *
    * @param sequence
    *          the sequence to evaluate
@@ -77,9 +77,8 @@ public static IBooleanItem fnBoolean(@NonNull ISequence<?> sequence) {
   }
 
   /**
-   * A helper method that gets the effective boolean value of the provided
-   * sequence based on <a href="https://www.w3.org/TR/xpath-31/#id-ebv">XPath
-   * 3.1</a>.
+   * A helper method that gets the effective boolean value of the provided sequence based on
+   * <a href="https://www.w3.org/TR/xpath-31/#id-ebv">XPath 3.1</a>.
    *
    * @param sequence
    *          the sequence to evaluate
@@ -99,8 +98,8 @@ public static boolean fnBooleanAsPrimitive(@NonNull ISequence<?> sequence) {
   }
 
   /**
-   * A helper method that gets the effective boolean value of the provided item
-   * based on <a href="https://www.w3.org/TR/xpath-31/#id-ebv">XPath 3.1</a>.
+   * A helper method that gets the effective boolean value of the provided item based on
+   * <a href="https://www.w3.org/TR/xpath-31/#id-ebv">XPath 3.1</a>.
    *
    * @param item
    *          the item to evaluate

diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/FnCompare.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/function/library/FnCompare.java
@@ -20,14 +20,13 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 /**
- * Implements <a href=
- * "https://www.w3.org/TR/xpath-functions-31/#func-compare">fn:compare</a>.
+ * Implements <a href= "https://www.w3.org/TR/xpath-functions-31/#func-compare">fn:compare</a>.
  */
 public final class FnCompare {
-
+  private static final String NAME = "compare";
   @NonNull
   static final IFunction SIGNATURE = IFunction.builder()
-      .name("compare")
+      .name(NAME)
       .namespace(MetapathConstants.NS_METAPATH_FUNCTIONS)
       .deterministic()
       .contextDependent()