More code cleanup and refactoring

core/src/main/java-templates/gov/nist/secauto/metaschema/core/MetaschemaJavaVersion.java

@@ -3,15 +3,18 @@
 
 import gov.nist.secauto.metaschema.core.util.IVersionInfo;
 
+/**
+ * Provides version information for this library.
+ */
 public class MetaschemaJavaVersion implements IVersionInfo {
 
-  public static final String NAME = "metaschema-java";
-  public static final String VERSION = "${project.version}";
-  public static final String BUILD_TIMESTAMP = "${timestamp}";
-  public static final String COMMIT = "@git.commit.id.abbrev@";
-  public static final String BRANCH = "@git.branch@";
-  public static final String CLOSEST_TAG = "@git.closest.tag.name@";
-  public static final String ORIGIN = "@git.remote.origin.url@";
+  private static final String NAME = "metaschema-java";
+  private static final String VERSION = "${project.version}";
+  private static final String BUILD_TIMESTAMP = "${timestamp}";
+  private static final String COMMIT = "@git.commit.id.abbrev@";
+  private static final String BRANCH = "@git.branch@";
+  private static final String CLOSEST_TAG = "@git.closest.tag.name@";
+  private static final String ORIGIN = "@git.remote.origin.url@";
 
   @Override
   public String getName() {

core/src/main/java-templates/gov/nist/secauto/metaschema/core/model/MetaschemaVersion.java

@@ -4,15 +4,18 @@
 
 import gov.nist.secauto.metaschema.core.util.IVersionInfo;
 
+/**
+ * Provides version information for the underlying Metaschema implementation used by this library.
+ */
 public class MetaschemaVersion implements IVersionInfo {
 
-  public static final String NAME = "metaschema";
-  public static final String BUILD_VERSION = "${project.version}";
-  public static final String BUILD_TIMESTAMP = "${timestamp}";
-  public static final String COMMIT = "@metaschema-git.commit.id.abbrev@";
-  public static final String BRANCH = "@metaschema-git.branch@";
-  public static final String CLOSEST_TAG = "@metaschema-git.closest.tag.name@";
-  public static final String ORIGIN = "@metaschema-git.remote.origin.url@";
+  private static final String NAME = "metaschema";
+  private static final String BUILD_VERSION = "${project.version}";
+  private static final String BUILD_TIMESTAMP = "${timestamp}";
+  private static final String COMMIT = "@metaschema-git.commit.id.abbrev@";
+  private static final String BRANCH = "@metaschema-git.branch@";
+  private static final String CLOSEST_TAG = "@metaschema-git.closest.tag.name@";
+  private static final String ORIGIN = "@metaschema-git.remote.origin.url@";
 
   @Override
   public String getName() {
@@ -21,7 +24,7 @@ public String getName() {
 
   @Override
   public String getVersion() {
-    return CLOSEST_TAG;
+    return BUILD_VERSION;
   }
 
   @Override

core/src/main/java/gov/nist/secauto/metaschema/core/datatype/AbstractCustomJavaDataTypeAdapter.java

@@ -43,5 +43,4 @@ public TYPE copy(Object obj) {
     // method.
     return ((TYPE) obj).copy();
   }
-
 }

core/src/main/java/gov/nist/secauto/metaschema/core/datatype/AbstractDataTypeAdapter.java

@@ -8,7 +8,6 @@
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonParser;
 
-import gov.nist.secauto.metaschema.core.metapath.function.InvalidValueForCastFunctionException;
 import gov.nist.secauto.metaschema.core.metapath.item.atomic.IAnyAtomicItem;
 import gov.nist.secauto.metaschema.core.model.util.JsonUtil;
 import gov.nist.secauto.metaschema.core.model.util.XmlEventUtil;
@@ -197,46 +196,47 @@ public void writeJsonValue(Object value, JsonGenerator generator) throws IOExcep
 
   @Override
   public abstract ITEM_TYPE newItem(Object value);
-
-  @SuppressWarnings("unchecked")
-  @Override
-  public ITEM_TYPE cast(IAnyAtomicItem item) {
-    if (item == null) {
-      throw new InvalidValueForCastFunctionException("item is null");
-    }
-    return getItemClass().isAssignableFrom(item.getClass())
-        ? (ITEM_TYPE) item
-        : castInternal(item);
-  }
-
-  /**
-   * Attempt to cast the provided item to this adapter's item type.
-   * <p>
-   * The default implementation of this will attempt to parse the provided item as
-   * a string using the {@link #parse(String)} method. If this behavior is
-   * undesirable, then a subclass should override this method.
-   *
-   * @param item
-   *          the item to cast
-   * @return the item casted to this adapter's item type
-   * @throws InvalidValueForCastFunctionException
-   *           if the casting of the item is not possible because the item
-   *           represents an invalid value for this adapter's item type
-   */
-  @NonNull
-  protected ITEM_TYPE castInternal(@NonNull IAnyAtomicItem item) {
-    // try string based casting as a fallback
-    String itemString;
-    try {
-      itemString = item.asString();
-      TYPE value = parse(itemString);
-      return newItem(value);
-    } catch (IllegalArgumentException | IllegalStateException ex) {
-      throw new InvalidValueForCastFunctionException(
-          String.format("The value '%s' is not compatible with the type '%s'",
-              item.getValue(),
-              getItemClass().getName()),
-          ex);
-    }
-  }
+  //
+  // @SuppressWarnings("unchecked")
+  // @Override
+  // public ITEM_TYPE cast(IAnyAtomicItem item) {
+  // if (item == null) {
+  // throw new InvalidValueForCastFunctionException("item is null");
+  // }
+  // return getItemClass().isAssignableFrom(item.getClass())
+  // ? (ITEM_TYPE) item
+  // : castInternal(item);
+  // }
+  //
+  // /**
+  // * Attempt to cast the provided item to this adapter's item type.
+  // * <p>
+  // * The default implementation of this will attempt to parse the provided item
+  // as
+  // * a string using the {@link #parse(String)} method. If this behavior is
+  // * undesirable, then a subclass should override this method.
+  // *
+  // * @param item
+  // * the item to cast
+  // * @return the item casted to this adapter's item type
+  // * @throws InvalidValueForCastFunctionException
+  // * if the casting of the item is not possible because the item
+  // * represents an invalid value for this adapter's item type
+  // */
+  // @NonNull
+  // protected ITEM_TYPE castInternal(@NonNull IAnyAtomicItem item) {
+  // // try string based casting as a fallback
+  // String itemString;
+  // try {
+  // itemString = item.asString();
+  // TYPE value = parse(itemString);
+  // return newItem(value);
+  // } catch (IllegalArgumentException | IllegalStateException ex) {
+  // throw new InvalidValueForCastFunctionException(
+  // String.format("The value '%s' is not compatible with the type '%s'",
+  // item.getValue(),
+  // getItemClass().getName()),
+  // ex);
+  // }
+  // }
 }

core/src/main/java/gov/nist/secauto/metaschema/core/datatype/IDataTypeAdapter.java

@@ -9,7 +9,6 @@
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes;
 
-import gov.nist.secauto.metaschema.core.metapath.function.InvalidValueForCastFunctionException;
 import gov.nist.secauto.metaschema.core.metapath.item.atomic.IAnyAtomicItem;
 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
 
@@ -142,19 +141,19 @@ default boolean isAtomic() {
   // TODO: move to IAnyAtomicItem
   @NonNull
   IAnyAtomicItem newItem(@NonNull Object value);
-
-  /**
-   * Cast the provided item to an item of this type, if possible.
-   *
-   * @param item
-   *          the atomic item to cast
-   * @return an atomic item of this type
-   * @throws InvalidValueForCastFunctionException
-   *           if the provided item type cannot be cast to this item type
-   */
-  // TODO: move to IAnyAtomicItem
-  @NonNull
-  IAnyAtomicItem cast(IAnyAtomicItem item);
+  //
+  // /**
+  // * Cast the provided item to an item of this type, if possible.
+  // *
+  // * @param item
+  // * the atomic item to cast
+  // * @return an atomic item of this type
+  // * @throws InvalidValueForCastFunctionException
+  // * if the provided item type cannot be cast to this item type
+  // */
+  // // TODO: move to IAnyAtomicItem
+  // @NonNull
+  // IAnyAtomicItem cast(IAnyAtomicItem item);
 
   /**
    * Determines if adapter can parse the next element. The next element's

core/src/main/java/gov/nist/secauto/metaschema/core/datatype/adapter/AbstractIntegerAdapter.java

@@ -39,7 +39,11 @@ public JsonFormatTypes getJsonRawType() {
 
   @Override
   public BigInteger parse(String value) {
-    return new BigInteger(value);
+    try {
+      return new BigInteger(value);
+    } catch (NumberFormatException ex) {
+      throw new IllegalArgumentException(ex);
+    }
   }
 
   @Override

core/src/main/java/gov/nist/secauto/metaschema/core/datatype/adapter/Base64Adapter.java

@@ -20,6 +20,11 @@
 
 import edu.umd.cs.findbugs.annotations.NonNull;
 
+/**
+ * Support for the Metaschema <a href=
+ * "https://pages.nist.gov/metaschema/specification/datatypes/#base64">base64</a>
+ * data type.
+ */
 public class Base64Adapter
     extends AbstractDataTypeAdapter<ByteBuffer, IBase64BinaryItem> {
   @NonNull
@@ -43,12 +48,11 @@ public JsonFormatTypes getJsonRawType() {
     return JsonFormatTypes.STRING;
   }
 
-  @SuppressWarnings("null")
   @Override
   public ByteBuffer parse(String value) {
     Base64.Decoder decoder = Base64.getDecoder();
     byte[] result = decoder.decode(value);
-    return ByteBuffer.wrap(result);
+    return ObjectUtils.notNull(ByteBuffer.wrap(result));
   }
 
   @Override
@@ -62,11 +66,10 @@ public ByteBuffer copy(Object obj) {
     return clone;
   }
 
-  @SuppressWarnings("null")
   @Override
   public String asString(Object value) {
     Base64.Encoder encoder = Base64.getEncoder();
-    return encoder.encodeToString(((ByteBuffer) value).array());
+    return ObjectUtils.notNull(encoder.encodeToString(((ByteBuffer) value).array()));
   }
 
   @Override

core/src/main/java/gov/nist/secauto/metaschema/core/datatype/adapter/BooleanAdapter.java

@@ -11,11 +11,7 @@
 
 import gov.nist.secauto.metaschema.core.datatype.AbstractDataTypeAdapter;
 import gov.nist.secauto.metaschema.core.metapath.MetapathConstants;
-import gov.nist.secauto.metaschema.core.metapath.function.InvalidValueForCastFunctionException;
-import gov.nist.secauto.metaschema.core.metapath.item.atomic.IAnyAtomicItem;
 import gov.nist.secauto.metaschema.core.metapath.item.atomic.IBooleanItem;
-import gov.nist.secauto.metaschema.core.metapath.item.atomic.INumericItem;
-import gov.nist.secauto.metaschema.core.metapath.item.atomic.IStringItem;
 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
 
 import java.io.IOException;
@@ -92,57 +88,4 @@ public IBooleanItem newItem(Object value) {
     return IBooleanItem.valueOf(item);
   }
 
-  @Override
-  protected IBooleanItem castInternal(@NonNull IAnyAtomicItem item) {
-    IBooleanItem retval;
-    if (item instanceof INumericItem) {
-      retval = castToBoolean((INumericItem) item);
-    } else if (item instanceof IStringItem) {
-      retval = castToBoolean((IStringItem) item);
-    } else {
-      try {
-        retval = castToBoolean(item.asStringItem());
-      } catch (IllegalStateException ex) {
-        throw new InvalidValueForCastFunctionException(ex.getLocalizedMessage(), ex);
-      }
-    }
-    return retval;
-  }
-
-  /**
-   * Cast the provided numeric value to a boolean. Any non-zero value will be
-   * {@code true}, or {@code false} otherwise.
-   *
-   * @param item
-   *          the item to cast
-   * @return {@code true} if the item value is non-zero, or {@code false}
-   *         otherwise
-   */
-  @NonNull
-  protected IBooleanItem castToBoolean(@NonNull INumericItem item) {
-    return IBooleanItem.valueOf(item.toEffectiveBoolean());
-  }
-
-  /**
-   * If the string is a numeric value, treat it as so. Otherwise parse the value
-   * as a boolean string.
-   *
-   * @param item
-   *          the item to cast
-   * @return the effective boolean value of the string
-   * @throws InvalidValueForCastFunctionException
-   *           if the provided item cannot be cast to a boolean value by any means
-   */
-  @NonNull
-  protected IBooleanItem castToBoolean(@NonNull IStringItem item) {
-    IBooleanItem retval;
-    try {
-      INumericItem numeric = INumericItem.cast(item);
-      retval = castToBoolean(numeric);
-    } catch (InvalidValueForCastFunctionException ex) {
-      retval = super.castInternal(item);
-    }
-    return retval;
-  }
-
 }