From 6f27d6673f0a827216fabc0a4531f429d753de71 Mon Sep 17 00:00:00 2001
From: David Waltermire <david.waltermire@gsa.gov>
Date: Sat, 2 Nov 2024 15:37:25 -0400
Subject: [PATCH] Minor refactoring.

---
 .../metaschema/cli/processor/CLIProcessor.java        |  9 +++------
 .../core/model/AbstractGlobalDefinition.java          |  6 ++++++
 .../core/model/AbstractInlineAssemblyDefinition.java  |  5 +++++
 .../core/model/AbstractInlineFieldDefinition.java     |  5 +++++
 .../metaschema/core/model/IAssemblyDefinition.java    |  6 ++++++
 .../secauto/metaschema/core/model/IDefinition.java    |  8 ++++++++
 .../core/model/IFeatureDefinitionInstanceInlined.java | 11 ++++++-----
 .../metaschema/core/model/IFieldDefinition.java       |  7 +++++++
 .../modules/sarif/SarifValidationHandler.java         |  3 +--
 .../secauto/metaschema/databind/IBindingContext.java  |  3 +--
 .../model/IBoundInstanceModelFieldScalar.java         |  5 +++++
 11 files changed, 53 insertions(+), 15 deletions(-)

diff --git a/cli-processor/src/main/java/gov/nist/secauto/metaschema/cli/processor/CLIProcessor.java b/cli-processor/src/main/java/gov/nist/secauto/metaschema/cli/processor/CLIProcessor.java
index 104fb9018..bfbcc84fa 100644
--- a/cli-processor/src/main/java/gov/nist/secauto/metaschema/cli/processor/CLIProcessor.java
+++ b/cli-processor/src/main/java/gov/nist/secauto/metaschema/cli/processor/CLIProcessor.java
@@ -215,8 +215,7 @@ public static void handleQuiet() {
   }
 
   protected void showVersion() {
-    @SuppressWarnings("resource")
-    PrintStream out = AnsiConsole.out(); // NOPMD - not owner
+    @SuppressWarnings("resource") PrintStream out = AnsiConsole.out(); // NOPMD - not owner
     getVersionInfos().values().stream().forEach(info -> {
       out.println(ansi()
           .bold().a(info.getName()).boldOff()
@@ -254,8 +253,7 @@ public class CallingContext {
 
     @SuppressFBWarnings(value = "CT_CONSTRUCTOR_THROW", justification = "Use of final fields")
     public CallingContext(@NonNull List<String> args) {
-      @SuppressWarnings("PMD.LooseCoupling")
-      LinkedList<ICommand> calledCommands = new LinkedList<>();
+      @SuppressWarnings("PMD.LooseCoupling") LinkedList<ICommand> calledCommands = new LinkedList<>();
       List<Option> options = new LinkedList<>(OPTIONS);
       List<String> extraArgs = new LinkedList<>();
 
@@ -633,8 +631,7 @@ public void showHelp() {
       HelpFormatter formatter = new HelpFormatter();
       formatter.setLongOptSeparator("=");
 
-      @SuppressWarnings("resource")
-      AnsiPrintStream out = AnsiConsole.out();
+      @SuppressWarnings("resource") AnsiPrintStream out = AnsiConsole.out();
 
       try (PrintWriter writer = new PrintWriter( // NOPMD not owned
           AutoCloser.preventClose(out),
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/model/AbstractGlobalDefinition.java b/core/src/main/java/gov/nist/secauto/metaschema/core/model/AbstractGlobalDefinition.java
index f89623f0d..2e0c28dd6 100644
--- a/core/src/main/java/gov/nist/secauto/metaschema/core/model/AbstractGlobalDefinition.java
+++ b/core/src/main/java/gov/nist/secauto/metaschema/core/model/AbstractGlobalDefinition.java
@@ -60,6 +60,12 @@ public final QName getDefinitionQName() {
     return definitionQName.get();
   }
 
+  @Override
+  public boolean isInline() {
+    // never inline
+    return false;
+  }
+
   @Override
   public final INSTANCE getInlineInstance() {
     // never inline
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/model/AbstractInlineAssemblyDefinition.java b/core/src/main/java/gov/nist/secauto/metaschema/core/model/AbstractInlineAssemblyDefinition.java
index 42650c709..125147fdd 100644
--- a/core/src/main/java/gov/nist/secauto/metaschema/core/model/AbstractInlineAssemblyDefinition.java
+++ b/core/src/main/java/gov/nist/secauto/metaschema/core/model/AbstractInlineAssemblyDefinition.java
@@ -73,6 +73,11 @@ public final DEFINITION getDefinition() {
     return ObjectUtils.asType(this);
   }
 
+  @Override
+  public boolean isInline() {
+    return true;
+  }
+
   @Override
   @NonNull
   public final INSTANCE getInlineInstance() {
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/model/AbstractInlineFieldDefinition.java b/core/src/main/java/gov/nist/secauto/metaschema/core/model/AbstractInlineFieldDefinition.java
index 6d7ed14eb..6e846c851 100644
--- a/core/src/main/java/gov/nist/secauto/metaschema/core/model/AbstractInlineFieldDefinition.java
+++ b/core/src/main/java/gov/nist/secauto/metaschema/core/model/AbstractInlineFieldDefinition.java
@@ -49,6 +49,11 @@ public final DEFINITION getDefinition() {
     return ObjectUtils.asType(this);
   }
 
+  @Override
+  public boolean isInline() {
+    return true;
+  }
+
   @Override
   @NonNull
   public final INSTANCE getInlineInstance() {
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/model/IAssemblyDefinition.java b/core/src/main/java/gov/nist/secauto/metaschema/core/model/IAssemblyDefinition.java
index 5a214ec42..e97439113 100644
--- a/core/src/main/java/gov/nist/secauto/metaschema/core/model/IAssemblyDefinition.java
+++ b/core/src/main/java/gov/nist/secauto/metaschema/core/model/IAssemblyDefinition.java
@@ -77,6 +77,12 @@ default String getRootJsonName() {
     return getRootName();
   }
 
+  @Override
+  default boolean isInline() {
+    // not inline by default
+    return false;
+  }
+
   @Override
   default IAssemblyInstance getInlineInstance() {
     // not inline by default
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/model/IDefinition.java b/core/src/main/java/gov/nist/secauto/metaschema/core/model/IDefinition.java
index 739c89c77..7c8126140 100644
--- a/core/src/main/java/gov/nist/secauto/metaschema/core/model/IDefinition.java
+++ b/core/src/main/java/gov/nist/secauto/metaschema/core/model/IDefinition.java
@@ -60,9 +60,13 @@ default QName getDefinitionQName() {
   /**
    * Determine if the definition is defined inline, meaning the definition is
    * declared where it is used.
+   * <p>
+   * If this method returns {@code false}, then {@link #getInlineInstance()} must
+   * return {@code null}.
    *
    * @return {@code true} if the definition is declared inline or {@code false} if
    *         the definition is able to be globally referenced
+   * @see #getInlineInstance()
    */
   default boolean isInline() {
     return getInlineInstance() != null;
@@ -71,8 +75,12 @@ default boolean isInline() {
   /**
    * If {@link #isInline()} is {@code true}, return the instance the definition is
    * inlined for.
+   * <p>
+   * If this method returns {@code null}, then {@link #getInlineInstance()} must
+   * return {@code false}.
    *
    * @return the instance or {@code null} otherwise
+   * @see #isInline()
    */
   INamedInstance getInlineInstance();
 
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/model/IFeatureDefinitionInstanceInlined.java b/core/src/main/java/gov/nist/secauto/metaschema/core/model/IFeatureDefinitionInstanceInlined.java
index cafc31de5..3ebb543dc 100644
--- a/core/src/main/java/gov/nist/secauto/metaschema/core/model/IFeatureDefinitionInstanceInlined.java
+++ b/core/src/main/java/gov/nist/secauto/metaschema/core/model/IFeatureDefinitionInstanceInlined.java
@@ -28,11 +28,6 @@ public interface IFeatureDefinitionInstanceInlined<
     DEFINITION extends IDefinition,
     INSTANCE extends INamedInstance>
     extends IDefinition, INamedInstance {
-  @Override
-  default boolean isInline() {
-    // has to be inline
-    return true;
-  }
 
   @Override
   default QName getDefinitionQName() {
@@ -44,6 +39,12 @@ default DEFINITION getDefinition() {
     return ObjectUtils.asType(this);
   }
 
+  @Override
+  default boolean isInline() {
+    // has to be inline
+    return true;
+  }
+
   @Override
   @NonNull
   default INSTANCE getInlineInstance() {
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/model/IFieldDefinition.java b/core/src/main/java/gov/nist/secauto/metaschema/core/model/IFieldDefinition.java
index 76b59d538..b40f52fd8 100644
--- a/core/src/main/java/gov/nist/secauto/metaschema/core/model/IFieldDefinition.java
+++ b/core/src/main/java/gov/nist/secauto/metaschema/core/model/IFieldDefinition.java
@@ -9,6 +9,13 @@
 import edu.umd.cs.findbugs.annotations.Nullable;
 
 public interface IFieldDefinition extends IModelDefinition, IValuedDefinition, IField {
+
+  @Override
+  default boolean isInline() {
+    // not inline by default
+    return false;
+  }
+
   @Override
   default IFieldInstance getInlineInstance() {
     // not inline by default
diff --git a/databind-metaschema/src/main/java/gov/nist/secauto/metaschema/modules/sarif/SarifValidationHandler.java b/databind-metaschema/src/main/java/gov/nist/secauto/metaschema/modules/sarif/SarifValidationHandler.java
index 31b4e779b..49a2b55d4 100644
--- a/databind-metaschema/src/main/java/gov/nist/secauto/metaschema/modules/sarif/SarifValidationHandler.java
+++ b/databind-metaschema/src/main/java/gov/nist/secauto/metaschema/modules/sarif/SarifValidationHandler.java
@@ -466,8 +466,7 @@ public List<Result> generateResults(@NonNull URI output) throws IOException {
         assert constraint != null;
         ConstraintRuleRecord rule = getRuleRecord(constraint);
 
-        @SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops")
-        Result result = new Result();
+        @SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops") Result result = new Result();
 
         String id = constraint.getId();
         if (id != null) {
diff --git a/databind/src/main/java/gov/nist/secauto/metaschema/databind/IBindingContext.java b/databind/src/main/java/gov/nist/secauto/metaschema/databind/IBindingContext.java
index 890092d85..7492495c4 100644
--- a/databind/src/main/java/gov/nist/secauto/metaschema/databind/IBindingContext.java
+++ b/databind/src/main/java/gov/nist/secauto/metaschema/databind/IBindingContext.java
@@ -826,8 +826,7 @@ default IValidationResult validateWithSchema(
       switch (asFormat) {
       case JSON: {
         JSONObject json;
-        try (@SuppressWarnings("resource")
-        InputStream is
+        try (@SuppressWarnings("resource") InputStream is
             = new BufferedInputStream(ObjectUtils.notNull(targetResource.openStream()))) {
           json = new JSONObject(new JSONTokener(is));
         }
diff --git a/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/IBoundInstanceModelFieldScalar.java b/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/IBoundInstanceModelFieldScalar.java
index dd25c11d8..37d7b01d0 100644
--- a/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/IBoundInstanceModelFieldScalar.java
+++ b/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/IBoundInstanceModelFieldScalar.java
@@ -26,6 +26,11 @@ default IBoundDefinitionModelField<Object> getDefinition() {
     return IFeatureDefinitionInstanceInlined.super.getDefinition();
   }
 
+  @Override
+  default boolean isInline() {
+    return IFeatureDefinitionInstanceInlined.super.isInline();
+  }
+
   @Override
   default IBoundInstanceModelFieldScalar getInlineInstance() {
     return IFeatureDefinitionInstanceInlined.super.getInlineInstance();