Performed light refactoring and created javadocs for the databind mod…

…ule. Cleaned up stream closure.
usnistgov · Jul 3, 2024 · 2f3d3bf · 2f3d3bf
1 parent 61447eb
commit 2f3d3bf
Show file tree

Hide file tree

Showing 11 changed files with 93 additions and 48 deletions.
diff --git a/databind/pom.xml b/databind/pom.xml
@@ -89,6 +89,10 @@
 			<scope>test</scope>
 		</dependency>
 
+		<dependency>
+		    <groupId>org.eclipse.jdt</groupId>
+		    <artifactId>org.eclipse.jdt.annotation</artifactId>
+		</dependency>
 	</dependencies>
 	<build>
 		<pluginManagement>

diff --git a/...bind/src/main/java/gov/nist/secauto/metaschema/databind/codegen/ModuleCompilerHelper.java b/...bind/src/main/java/gov/nist/secauto/metaschema/databind/codegen/ModuleCompilerHelper.java
@@ -33,6 +33,7 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.eclipse.jdt.annotation.Owning;
 
 import java.io.IOException;
 import java.lang.module.ModuleDescriptor;
@@ -138,21 +139,26 @@ public static IProduction compileModule(
    *          load a class
    * @return the new class loader
    */
-  @SuppressWarnings("null")
   @NonNull
   public static ClassLoader newClassLoader(
       @NonNull final Path classDir,
       @NonNull final ClassLoader parent) {
-    return AccessController.doPrivileged(new PrivilegedAction<>() {
-      @Override
-      public URLClassLoader run() {
-        try {
-          return new URLClassLoader(new URL[] { classDir.toUri().toURL() }, parent);
-        } catch (MalformedURLException ex) {
-          throw new IllegalStateException("unable to configure class loader", ex);
-        }
-      }
-    });
+    ClassLoader retval = AccessController
+        .doPrivileged((PrivilegedAction<ClassLoader>) () -> newClassLoaderInternal(classDir, parent));
+    assert retval != null;
+    return retval;
+  }
+
+  @Owning
+  @NonNull
+  private static ClassLoader newClassLoaderInternal(
+      @NonNull final Path classDir,
+      @NonNull final ClassLoader parent) {
+    try {
+      return new URLClassLoader(new URL[] { classDir.toUri().toURL() }, parent);
+    } catch (MalformedURLException ex) {
+      throw new IllegalStateException("unable to configure class loader", ex);
+    }
   }
 
   @SuppressWarnings({

diff --git a/...java/gov/nist/secauto/metaschema/databind/codegen/config/DefaultBindingConfiguration.java b/...java/gov/nist/secauto/metaschema/databind/codegen/config/DefaultBindingConfiguration.java
@@ -126,6 +126,12 @@ public String getClassName(IModelDefinition definition) {
     return retval;
   }
 
+  @Override
+  public @NonNull String getClassName(@NonNull IModule module) {
+    // TODO: make this configurable
+    return ClassUtils.toClassName(module.getShortName() + "Module");
+  }
+
   @Override
   public List<String> getQualifiedSuperinterfaceClassNames(IModelDefinition definition) {
     IDefinitionBindingConfiguration config = getBindingConfigurationForDefinition(definition);
@@ -134,12 +140,6 @@ public List<String> getQualifiedSuperinterfaceClassNames(IModelDefinition defini
         : config.getInterfacesToImplement();
   }
 
-  @Override
-  public @NonNull String getClassName(@NonNull IModule module) {
-    // TODO: make this configurable
-    return ClassUtils.toClassName(module.getShortName() + "Module");
-  }
-
   /**
    * Binds an XML namespace, which is normally associated with one or more Module,
    * with a provided Java package name.

diff --git a/.../main/java/gov/nist/secauto/metaschema/databind/codegen/typeinfo/DefaultTypeResolver.java b/.../main/java/gov/nist/secauto/metaschema/databind/codegen/typeinfo/DefaultTypeResolver.java
@@ -277,9 +277,9 @@ public ClassName getBaseClassName(IModelDefinition definition) {
   @Override
   public List<ClassName> getSuperinterfaces(IModelDefinition definition) {
     List<String> classNames = bindingConfiguration.getQualifiedSuperinterfaceClassNames(definition);
-    return classNames.stream()
+    return ObjectUtils.notNull(classNames.stream()
         .map(ClassName::bestGuess)
-        .collect(Collectors.toUnmodifiableList());
+        .collect(Collectors.toUnmodifiableList()));
   }
 
   @Override

diff --git a/...nd/src/main/java/gov/nist/secauto/metaschema/databind/codegen/typeinfo/ITypeResolver.java b/...nd/src/main/java/gov/nist/secauto/metaschema/databind/codegen/typeinfo/ITypeResolver.java
@@ -169,6 +169,16 @@ IGroupedNamedModelInstanceTypeInfo getTypeInfo(
   @NonNull
   ClassName getClassName(@NonNull IModelDefinition definition);
 
+  /**
+   * Get the name of the class associated with the provided Metaschema definition.
+   *
+   * @param typeInfo
+   *          the type information to get the class name for
+   * @return the class name information for the definition
+   */
+  @NonNull
+  ClassName getClassName(@NonNull INamedModelInstanceTypeInfo typeInfo);
+
   /**
    * Get the name of the super interfaces associated with the provided Metaschema
    * definition.
@@ -180,16 +190,6 @@ IGroupedNamedModelInstanceTypeInfo getTypeInfo(
   @NonNull
   List<ClassName> getSuperinterfaces(@NonNull IModelDefinition definition);
 
-  /**
-   * Get the name of the class associated with the provided Metaschema definition.
-   *
-   * @param typeInfo
-   *          the type information to get the class name for
-   * @return the class name information for the definition
-   */
-  @NonNull
-  ClassName getClassName(@NonNull INamedModelInstanceTypeInfo typeInfo);
-
   /**
    * Get the name of the class associated with the provided Metaschema definition
    * using the provided {@code postfix}. This class will be a child of the

diff --git a/databind/src/main/java/gov/nist/secauto/metaschema/databind/io/DefaultBoundLoader.java b/databind/src/main/java/gov/nist/secauto/metaschema/databind/io/DefaultBoundLoader.java
@@ -37,6 +37,9 @@
 import gov.nist.secauto.metaschema.databind.IBindingContext;
 import gov.nist.secauto.metaschema.databind.io.ModelDetector.Result;
 
+import org.eclipse.jdt.annotation.NotOwning;
+import org.eclipse.jdt.annotation.Owning;
+
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URI;
@@ -156,7 +159,8 @@ private ModelDetector getModelDetector() {
   }
 
   @Override
-  public Result detectModel(InputStream is, Format format) throws IOException {
+  @Owning
+  public Result detectModel(@NotOwning InputStream is, Format format) throws IOException {
     return getModelDetector().detect(is, format);
   }
 
@@ -244,15 +248,17 @@ public IDocumentNodeItem loadAsNodeItem(Format format, URI uri) throws IOExcepti
   }
 
   @Override
-  public IDocumentNodeItem loadAsNodeItem(Format format, InputStream is, URI documentUri) throws IOException {
-    ModelDetector.Result modelMatch = detectModel(is, format);
-
-    IDeserializer<?> deserializer = getDeserializer(
-        modelMatch.getBoundClass(),
-        format,
-        getConfiguration());
-    try (InputStream modelStream = modelMatch.getDataStream()) {
-      return (IDocumentNodeItem) deserializer.deserializeToNodeItem(modelStream, documentUri);
+  public IDocumentNodeItem loadAsNodeItem(Format format, InputStream is, URI documentUri)
+      throws IOException {
+    try (ModelDetector.Result modelMatch = detectModel(is, format)) {
+
+      IDeserializer<?> deserializer = getDeserializer(
+          modelMatch.getBoundClass(),
+          format,
+          getConfiguration());
+      try (InputStream modelStream = modelMatch.getDataStream()) {
+        return (IDocumentNodeItem) deserializer.deserializeToNodeItem(modelStream, documentUri);
+      }
     }
   }
 

diff --git a/databind/src/main/java/gov/nist/secauto/metaschema/databind/io/IBoundLoader.java b/databind/src/main/java/gov/nist/secauto/metaschema/databind/io/IBoundLoader.java
@@ -35,6 +35,7 @@
 import gov.nist.secauto.metaschema.databind.DefaultBindingContext;
 import gov.nist.secauto.metaschema.databind.IBindingContext;
 
+import org.eclipse.jdt.annotation.Owning;
 import org.xml.sax.InputSource;
 
 import java.io.File;
@@ -168,6 +169,7 @@ default Format detectFormat(@NonNull URL url) throws IOException {
    *           if an error occurred while reading the resource
    */
   @NonNull
+  @Owning
   ModelDetector.Result detectModel(@NonNull InputStream is, @NonNull Format format) throws IOException;
 
   /**

diff --git a/databind/src/main/java/gov/nist/secauto/metaschema/databind/io/ModelDetector.java b/databind/src/main/java/gov/nist/secauto/metaschema/databind/io/ModelDetector.java
@@ -43,8 +43,11 @@
 
 import org.codehaus.stax2.XMLEventReader2;
 import org.codehaus.stax2.XMLInputFactory2;
+import org.eclipse.jdt.annotation.NotOwning;
+import org.eclipse.jdt.annotation.Owning;
 
 import java.io.ByteArrayInputStream;
+import java.io.Closeable;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
@@ -122,23 +125,30 @@ private IConfiguration<DeserializationFeature<?>> getConfiguration() {
    *           if an error occurred while reading the resource
    */
   @NonNull
-  public Result detect(@NonNull InputStream inputStream, @NonNull Format format)
+  @Owning
+  public Result detect(@NonNull @NotOwning InputStream inputStream, @NonNull Format format)
       throws IOException {
     byte[] buf = ObjectUtils.notNull(inputStream.readNBytes(getLookaheadLimit()));
 
     Class<? extends IBoundObject> clazz;
     try (InputStream bis = new ByteArrayInputStream(buf)) {
+      assert bis != null;
       switch (format) {
       case JSON:
-        clazz = detectModelJsonClass(ObjectUtils.notNull(
-            JsonFactoryFactory.instance().createParser(bis)));
+        try (JsonParser parser = JsonFactoryFactory.instance().createParser(bis)) {
+          assert parser != null;
+          clazz = detectModelJsonClass(parser);
+        }
         break;
       case YAML:
         YAMLFactory factory = YamlFactoryFactory.newParserFactoryInstance(getConfiguration());
-        clazz = detectModelJsonClass(ObjectUtils.notNull(factory.createParser(bis)));
+        try (JsonParser parser = factory.createParser(bis)) {
+          assert parser != null;
+          clazz = detectModelJsonClass(parser);
+        }
         break;
       case XML:
-        clazz = detectModelXmlClass(ObjectUtils.notNull(bis));
+        clazz = detectModelXmlClass(bis);
         break;
       default:
         throw new UnsupportedOperationException(
@@ -204,11 +214,11 @@ private Class<? extends IBoundObject> detectModelJsonClass(@NonNull JsonParser p
     return retval;
   }
 
-  public static final class Result {
+  public static final class Result implements Closeable {
     @NonNull
     private final Class<? extends IBoundObject> boundClass;
-    @NonNull
-    private final InputStream dataStream;
+    @Owning
+    private InputStream dataStream;
 
     private Result(
         @NonNull Class<? extends IBoundObject> clazz,
@@ -235,8 +245,15 @@ public Class<? extends IBoundObject> getBoundClass() {
      * @return the stream
      */
     @NonNull
+    @Owning
     public InputStream getDataStream() {
-      return dataStream;
+      return ObjectUtils.requireNonNull(dataStream, "data stream already closed");
+    }
+
+    @Override
+    public void close() throws IOException {
+      this.dataStream.close();
+      this.dataStream = null;
     }
   }
 }
diff --git a/databind/src/main/java/module-info.java b/databind/src/main/java/module-info.java
@@ -43,6 +43,7 @@
 
   requires flexmark.util.sequence;
   requires transitive com.google.auto.service;
+  requires org.eclipse.jdt.annotation;
 
   exports gov.nist.secauto.metaschema.databind;
   exports gov.nist.secauto.metaschema.databind.codegen;

diff --git a/metaschema-cli/src/main/assembly/bin.xml b/metaschema-cli/src/main/assembly/bin.xml
@@ -14,6 +14,10 @@
 			<outputDirectory>/lib</outputDirectory>
 			<outputFileNameMapping>${artifact.groupId}.${artifact.artifactId}-${artifact.version}.${artifact.extension}</outputFileNameMapping>
 			<useProjectArtifact>true</useProjectArtifact>
+			<excludes>
+				<exclude>org.jetbrains:annotations</exclude>
+				<exclude>org.eclipse.jdt:org.eclipse.jdt.annotation</exclude>
+			</excludes>
 		</dependencySet>
 	</dependencySets>
 	<fileSets>

diff --git a/pom.xml b/pom.xml
@@ -533,6 +533,11 @@
 				<artifactId>biz.aQute.bnd.util</artifactId>
 				<version>6.4.1</version>
 			</dependency>
+			<dependency>
+			    <groupId>org.eclipse.jdt</groupId>
+			    <artifactId>org.eclipse.jdt.annotation</artifactId>
+			    <version>2.3.0</version>
+			</dependency>
 		</dependencies>
 	</dependencyManagement>
 	<dependencies>