You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by el...@apache.org on 2024/12/03 12:07:16 UTC
(maven-jlink-plugin) 01/01: API doc copy edits
This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch typo
in repository https://gitbox.apache.org/repos/asf/maven-jlink-plugin.git
commit a41382323c55702acfdad1e169bdb6a6d0bbc67c
Author: Elliotte Rusty Harold <el...@ibiblio.org>
AuthorDate: Tue Dec 3 07:07:04 2024 -0500
API doc copy edits
---
.../maven/plugins/jlink/AbstractJLinkMojo.java | 23 +++++++++++-----------
.../jlink/AbstractJLinkToolchainExecutor.java | 9 +++------
2 files changed, 15 insertions(+), 17 deletions(-)
diff --git a/src/main/java/org/apache/maven/plugins/jlink/AbstractJLinkMojo.java b/src/main/java/org/apache/maven/plugins/jlink/AbstractJLinkMojo.java
index c99ac2f..8927492 100644
--- a/src/main/java/org/apache/maven/plugins/jlink/AbstractJLinkMojo.java
+++ b/src/main/java/org/apache/maven/plugins/jlink/AbstractJLinkMojo.java
@@ -173,15 +173,15 @@ public abstract class AbstractJLinkMojo extends AbstractMojo {
/**
* This will convert a module path separated by either {@code :} or {@code ;} into a string which uses the platform
- * depend path separator uniformly.
+ * path separator uniformly.
*
- * @param pluginModulePath The module path.
- * @return The platform separated module path.
+ * @param pluginModulePath the module path
+ * @return the platform separated module path
*/
protected StringBuilder convertSeparatedModulePathToPlatformSeparatedModulePath(String pluginModulePath) {
StringBuilder sb = new StringBuilder();
- // Split the module path by either ":" or ";" linux/windows path separator and
- // convert uniformly to the platform used separator.
+ // Split the module path by either ":" or ";" Linux/Windows path separator and
+ // convert uniformly to the platform separator.
String[] splitModule = pluginModulePath.split("[;:]");
for (String module : splitModule) {
if (sb.length() > 0) {
@@ -193,19 +193,20 @@ public abstract class AbstractJLinkMojo extends AbstractMojo {
}
/**
- * Convert a list into a string which is separated by platform depend path separator.
+ * Convert a list into a string which is separated by the platform path separator.
*
- * @param modulePaths The list of elements.
- * @return The string which contains the elements separated by {@link File#pathSeparatorChar}.
+ * @param modulePaths the list of elements
+ * @return the string which contains the elements separated by {@link File#pathSeparatorChar}.
*/
protected String getPlatformDependSeparateList(Collection<String> modulePaths) {
return String.join(Character.toString(File.pathSeparatorChar), modulePaths);
}
/**
- * Convert a list into a
- * @param modules The list of modules.
- * @return The string with the module list which is separated by {@code ,}.
+ * Convert a list of modules into a comma separated string.
+ *
+ * @param modules the list of modules
+ * @return the string with the module list which is separated by {@code ,}
*/
protected String getCommaSeparatedList(Collection<String> modules) {
return String.join(",", modules);
diff --git a/src/main/java/org/apache/maven/plugins/jlink/AbstractJLinkToolchainExecutor.java b/src/main/java/org/apache/maven/plugins/jlink/AbstractJLinkToolchainExecutor.java
index 15fd7db..7aa40c6 100644
--- a/src/main/java/org/apache/maven/plugins/jlink/AbstractJLinkToolchainExecutor.java
+++ b/src/main/java/org/apache/maven/plugins/jlink/AbstractJLinkToolchainExecutor.java
@@ -114,7 +114,7 @@ abstract class AbstractJLinkToolchainExecutor extends AbstractJLinkExecutor {
getLog().error("Either JDK9+ or a toolchain "
+ "pointing to a JDK9+ containing a jlink binary is required.");
getLog().info("See https://maven.apache.org/guides/mini/guide-using-toolchains.html "
- + "for mor information.");
+ + "for more information.");
throw new IllegalStateException("Running on JDK8 and no toolchain found.");
}
@@ -162,9 +162,7 @@ abstract class AbstractJLinkToolchainExecutor extends AbstractJLinkExecutor {
if (exitCode != 0) {
- if (output != null && !output.isEmpty()) {
- // Reconsider to use WARN / ERROR ?
- // getLog().error( output );
+ if (output != null) {
for (String outputLine : output.split("\n")) {
getLog().error(outputLine);
}
@@ -181,8 +179,7 @@ abstract class AbstractJLinkToolchainExecutor extends AbstractJLinkExecutor {
throw new MojoExecutionException(msg.toString());
}
- if (output != null && !output.isEmpty()) {
- // getLog().info( output );
+ if (output != null) {
for (String outputLine : output.split("\n")) {
getLog().info(outputLine);
}