refactoring

Author: h908714124

compiler/src/main/java/net/jbock/context/ParseOrExitMethod.java

@@ -42,20 +42,20 @@ public class ParseOrExitMethod {
     MethodSpec define() {
 
         ParameterSpec args = builder(STRING_ARRAY, "args").build();
-        ParameterSpec notSuccess = builder(generatedTypes.parseResultType(), "notSuccess").build();
+        ParameterSpec notSuccess = builder(generatedTypes.parseResultType(), "failure").build();
         ParameterSpec err = builder(AtFileError.class, "err").build();
 
         CodeBlock.Builder code = CodeBlock.builder();
         if (allMappings.stream().anyMatch(Mapping::isRequired)) {
             code.beginControlFlow("if ($1N.length == 0 || $2S.equals($1N[0]))", args, "--help")
-                    .addStatement("$T.builder().build().printHelp($N())",
-                            StandardErrorHandler.class, createModelMethod.get())
+                    .add("$T.builder().build()\n", StandardErrorHandler.class).indent()
+                    .add(".printUsageDocumentation($N());\n", createModelMethod.get()).unindent()
                     .addStatement("$T.exit(0)", System.class)
                     .endControlFlow();
         } else {
             code.beginControlFlow("if ($1N.length > 0 && $2S.equals($1N[0]))", args, "--help")
-                    .addStatement("$T.builder().build().printHelp($N())",
-                            StandardErrorHandler.class, createModelMethod.get())
+                    .add("$T.builder().build()\n", StandardErrorHandler.class).indent()
+                    .add(".printUsageDocumentation($N());\n", createModelMethod.get()).unindent()
                     .addStatement("$T.exit(0)", System.class)
                     .endControlFlow();
         }
@@ -64,7 +64,7 @@ MethodSpec define() {
                 .add(".mapLeft($1N -> $1N.addModel($2N()))\n", err, createModelMethod.get())
                 .add(".flatMap(this::$N)\n", parseMethod.get())
                 .add(".orElseThrow($N -> {\n", notSuccess).indent()
-                .addStatement("$T.builder().build().handle($N)",
+                .addStatement("$T.builder().build().printErrorMessage($N)",
                         StandardErrorHandler.class, notSuccess)
                 .addStatement("$T.exit(1)", System.class)
                 .addStatement("return new $T()", RuntimeException.class).unindent()

core/src/main/java/net/jbock/contrib/StandardErrorHandler.java

@@ -1,7 +1,6 @@
 package net.jbock.contrib;
 
 import net.jbock.model.CommandModel;
-import net.jbock.util.HasMessage;
 import net.jbock.util.ParsingFailed;
 
 import java.io.PrintStream;
@@ -10,8 +9,8 @@
 import java.util.Map;
 
 /**
- * This class is responsible for standard error handling,
- * like printing messages and shutting down the JVM.
+ * A convenience class that performs standard error handling,
+ * like printing error messages and printing the usage documentation.
  */
 public final class StandardErrorHandler {
 
@@ -87,10 +86,9 @@ public Builder withMessages(Map<String, String> map) {
         }
 
         /**
-         * Set the value of the ansi attribute.
+         * Sets the value of the ansi attribute.
          *
          * @param ansi if ansi codes should be used
-         *         when printing the usage documentation
          * @return the builder instance
          */
         public Builder withAnsi(boolean ansi) {
@@ -99,7 +97,7 @@ public Builder withAnsi(boolean ansi) {
         }
 
         /**
-         * Create the error handler.
+         * Creates the error handler.
          *
          * @return an error handler
          */
@@ -117,26 +115,31 @@ public static Builder builder() {
         return new Builder();
     }
 
-    public void printHelp(CommandModel model) {
+    /**
+     * Prints the usage documentation.
+     *
+     * @param model command model
+     */
+    public void printUsageDocumentation(CommandModel model) {
         UsageDocumentation.builder(model)
                 .withOutputStream(out)
                 .withAnsi(ansi)
                 .withMessages(messages)
                 .withTerminalWidth(terminalWidth)
-                .build().printUsageDocumentation();
+                .build()
+                .printUsageDocumentation();
         out.flush();
     }
 
     /**
-     * This method does standard error handling like printing
-     * error messages, or printing usage documentation.
+     * Prints an error message.
      *
-     * @param parsingFailed an object describing the error condition
+     * @param failure an object describing the error condition
      */
-    public void handle(ParsingFailed parsingFailed) {
-        CommandModel model = parsingFailed.commandModel();
+    public void printErrorMessage(ParsingFailed failure) {
+        CommandModel model = failure.commandModel();
         AnsiStyle ansiStyle = AnsiStyle.create(ansi);
-        out.println(ansiStyle.red("ERROR:") + ' ' + ((HasMessage) parsingFailed).message());
+        out.println(ansiStyle.red("ERROR:") + ' ' + failure.message());
         List<String> synopsis = Synopsis.create(model)
                 .createSynopsis("Usage:");
         out.println(String.join(" ", synopsis));

core/src/main/java/net/jbock/util/ErrAtFile.java

@@ -8,7 +8,7 @@
  * Non-exceptional failure object, indicates that reading options
  * from the {@code @file} was unsuccessful.
  */
-public final class ErrAtFile extends ParsingFailed implements HasMessage {
+public final class ErrAtFile extends ParsingFailed {
 
     private final String message;
     private final Path atFile;

core/src/main/java/net/jbock/util/ErrConvert.java

@@ -7,7 +7,7 @@
  * Non-exceptional failure object that represents
  * any runtime error during a converter invocation.
  */
-public final class ErrConvert extends ParsingFailed implements HasMessage {
+public final class ErrConvert extends ParsingFailed {
 
     private final ConverterFailure converterFailure;
     private final Item item;

core/src/main/java/net/jbock/util/ErrMissingItem.java

@@ -9,7 +9,7 @@
  *
  * @see net.jbock.model.Multiplicity#REQUIRED
  */
-public final class ErrMissingItem extends ParsingFailed implements HasMessage {
+public final class ErrMissingItem extends ParsingFailed {
 
     private final Item item;
 

core/src/main/java/net/jbock/util/ErrToken.java

@@ -8,7 +8,7 @@
  *
  * @see net.jbock.Command
  */
-public final class ErrToken extends ParsingFailed implements HasMessage {
+public final class ErrToken extends ParsingFailed {
 
     private final ErrTokenType errorType;
     private final String token;

core/src/main/java/net/jbock/util/ExConvert.java

@@ -1,17 +1,14 @@
 package net.jbock.util;
 
-import net.jbock.Option;
-import net.jbock.Parameter;
-import net.jbock.Parameters;
 import net.jbock.model.CommandModel;
 
 /**
  * A checked exception to signal that an error has occurred
  * within a particular converter.
  *
- * @see Option#converter()
- * @see Parameter#converter()
- * @see Parameters#converter()
+ * <p>This class is internal API and should not be used
+ * in client code. It may be removed without warning in future
+ * releases.
  */
 public final class ExConvert extends ExNotSuccess {
 

core/src/main/java/net/jbock/util/ExMissingItem.java

@@ -6,7 +6,9 @@
  * A checked exception to signal that a required item was
  * missing in the command line input.
  *
- * @see net.jbock.model.Multiplicity#REQUIRED
+ * <p>This class is internal API and should not be used
+ * in client code. It may be removed without warning in future
+ * releases.
  */
 public final class ExMissingItem extends ExNotSuccess {
 

core/src/main/java/net/jbock/util/ExNotSuccess.java

@@ -7,6 +7,10 @@
  * in the generated code. These are checked exceptions, to
  * ensure none of them are thrown from the generated
  * parse method.
+ *
+ * <p>This class is internal API and should not be used
+ * in client code. It may be removed without warning in future
+ * releases.
  */
 public abstract class ExNotSuccess extends Exception {
 

core/src/main/java/net/jbock/util/ExToken.java

@@ -1,15 +1,16 @@
 package net.jbock.util;
 
 import net.jbock.model.CommandModel;
-import net.jbock.model.Item;
 
 /**
  * A checked exception to signal that a parsing error has occurred
  * that is not associated with a particular item.
  * Internal exception that may be thrown and caught
  * in the generated code.
  *
- * @see Item
+ * <p>This class is internal API and should not be used
+ * in client code. It may be removed without warning in future
+ * releases.
  */
 public final class ExToken extends ExNotSuccess {