Move the formatting of options in the Options class.

Author: desruisseaux

src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java

@@ -1451,7 +1451,7 @@ && getIncrementalExcludes().isEmpty())) {
         if (!success || logger.isDebugEnabled()) {
             IOException suppressed = null;
             try {
-                writeDebugFile(compilerConfiguration.options, dependencies, sourceFiles);
+                writeDebugFile(compilerConfiguration, dependencies, sourceFiles);
                 if (success && tipForCommandLineCompilation != null) {
                     logger.debug(tipForCommandLineCompilation);
                     tipForCommandLineCompilation = null;
@@ -1767,13 +1767,13 @@ private void writePlugin(MessageBuilder mb, String option, String value) {
      * If a file name contains embedded spaces, then the whole file name must be between double quotation marks.
      * The -J options are not supported.
      *
-     * @param options the compiler options
+     * @param compilerConfiguration options to provide to the compiler
      * @param dependencies the dependencies
      * @param sourceFiles all files to compile
      * @throws IOException if an error occurred while writing the debug file
      */
     private void writeDebugFile(
-            List<String> options, Map<PathType, List<Path>> dependencies, List<SourceFile> sourceFiles)
+            Options compilerConfiguration, Map<PathType, List<Path>> dependencies, List<SourceFile> sourceFiles)
             throws IOException {
         final Path path = getDebugFilePath();
         if (path == null) {
@@ -1784,36 +1784,8 @@ private void writeDebugFile(
                 .append(System.lineSeparator())
                 .append("    ")
                 .append(executable != null ? executable : compilerId);
-        boolean hasOptions = false;
         try (BufferedWriter out = Files.newBufferedWriter(path)) {
-            for (String option : options) {
-                if (option.isBlank()) {
-                    continue;
-                }
-                if (option.startsWith("-J")) {
-                    commandLine.append(' ').append(option);
-                    continue;
-                }
-                if (hasOptions) {
-                    if (option.charAt(0) == '-') {
-                        out.newLine();
-                    } else {
-                        out.write(' ');
-                    }
-                }
-                boolean needsQuote = option.indexOf(' ') >= 0;
-                if (needsQuote) {
-                    out.write('"');
-                }
-                out.write(option);
-                if (needsQuote) {
-                    out.write('"');
-                }
-                hasOptions = true;
-            }
-            if (hasOptions) {
-                out.newLine();
-            }
+            compilerConfiguration.format(commandLine, out);
             for (Map.Entry<PathType, List<Path>> entry : dependencies.entrySet()) {
                 String separator = "";
                 for (String element : entry.getKey().option(entry.getValue())) {

src/main/java/org/apache/maven/plugin/compiler/Options.java

@@ -20,6 +20,8 @@
 
 import javax.tools.OptionChecker;
 
+import java.io.IOException;
+import java.io.UncheckedIOException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
@@ -337,4 +339,60 @@ void addUnchecked(String arguments) {
             addUnchecked(Arrays.asList(arguments.split(" ")));
         }
     }
+
+    /**
+     * Formats the options for debugging purposes.
+     *
+     * @param commandLine the prefix where to put the {@code -J} options before all other options
+     * @param out where to put all options other than {@code -J}
+     * @throws IOException if an error occurred while writing an option
+     */
+    void format(final StringBuilder commandLine, final Appendable out) throws IOException {
+        boolean hasOptions = false;
+        for (String option : options) {
+            if (option.isBlank()) {
+                continue;
+            }
+            if (option.startsWith("-J")) {
+                if (commandLine.length() != 0) {
+                    commandLine.append(' ');
+                }
+                commandLine.append(option);
+                continue;
+            }
+            if (hasOptions) {
+                if (option.charAt(0) == '-') {
+                    out.append(System.lineSeparator());
+                } else {
+                    out.append(' ');
+                }
+            }
+            boolean needsQuote = option.indexOf(' ') >= 0;
+            if (needsQuote) {
+                out.append('"');
+            }
+            out.append(option);
+            if (needsQuote) {
+                out.append('"');
+            }
+            hasOptions = true;
+        }
+        if (hasOptions) {
+            out.append(System.lineSeparator());
+        }
+    }
+
+    /**
+     * {@return a string representatation of the options for debugging purposes}.
+     */
+    @Override
+    public String toString() {
+        var out = new StringBuilder(40);
+        try {
+            format(out, out);
+        } catch (IOException e) {
+            throw new UncheckedIOException(e);
+        }
+        return out.toString();
+    }
 }