Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[MJAVADOC-755] Use java.lang.String instead of StringUtils #208

Merged
merged 3 commits into from Jul 6, 2023
Merged

[MJAVADOC-755] Use java.lang.String instead of StringUtils #208

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42a2ab5
[MJAVADOC-755] Use java.lang.String instead of StringUtils
elharo Jul 1, 2023
e4c6024
improve javadoc
elharo Jul 6, 2023
4bf864e
typo
elharo Jul 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
49 changes: 27 additions & 22 deletions src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java
View file
Open in desktop
Expand Up @@ -99,7 +99,6 @@
import org.codehaus.plexus.util.DirectoryScanner;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.cli.CommandLineException;
import org.codehaus.plexus.util.cli.CommandLineUtils;
import org.codehaus.plexus.util.cli.Commandline;
Expand Down Expand Up @@ -200,24 +199,22 @@ protected static List<String> getExcludedPackages(
}

/**
* Convenience method to wrap an argument value in single quotes (i.e. <code>'</code>). Intended for values which
* may contain whitespaces. <br>
* To prevent javadoc error, the line separator (i.e. <code>\n</code>) are skipped.
* Convenience method to wrap a command line option-argument in single quotes (i.e. <code>'</code>). Intended for values which
* may contain whitespace. <br>
* Line feeds (i.e. <code>\n</code>) are replaced with spaces, and single quotes are backslash escaped.
*
* @param value the argument value.
* @return argument with quote
* @param value the option-argument
* @return quoted option-argument
*/
protected static String quotedArgument(String value) {
String arg = value;

if (arg != null && !arg.isEmpty()) {
if (arg.contains("'")) {
arg = StringUtils.replace(arg, "'", "\\'");
}
arg = arg.replace("'", "\\'");
arg = "'" + arg + "'";

// To prevent javadoc error
arg = StringUtils.replace(arg, "\n", " ");
arg = arg.replace("\n", " ");
}

return arg;
Expand Down Expand Up @@ -285,13 +282,13 @@ protected static void copyJavadocResources(File outputDirectory, File javadocDir
}

List<String> docFiles = FileUtils.getDirectoryNames(
javadocDir, "resources,**/doc-files", StringUtils.join(excludes.iterator(), ","), false, true);
javadocDir, "resources,**/doc-files", String.join(",", excludes), false, true);
for (String docFile : docFiles) {
File docFileOutput = new File(outputDirectory, docFile);
FileUtils.mkdir(docFileOutput.getAbsolutePath());
FileUtils.copyDirectoryStructure(new File(javadocDir, docFile), docFileOutput);
List<String> files = FileUtils.getFileAndDirectoryNames(
docFileOutput, StringUtils.join(excludes.iterator(), ","), null, true, true, true, true);
docFileOutput, String.join(",", excludes), null, true, true, true, true);
for (String filename : files) {
File file = new File(filename);

Expand Down Expand Up @@ -457,18 +454,21 @@ protected static JavaVersion getJavadocVersion(File javadocExe)
CommandLineUtils.StringStreamConsumer err = new JavadocOutputStreamConsumer();

int exitCode = CommandLineUtils.executeCommandLine(cmd, out, err);

String errOutput = err.getOutput(); // non-null
if (exitCode != 0) {
StringBuilder msg = new StringBuilder("Exit code: " + exitCode + " - " + err.getOutput());
StringBuilder msg = new StringBuilder("Exit code: " + exitCode + " - " + errOutput);
msg.append('\n');
msg.append("Command line was:").append(CommandLineUtils.toString(cmd.getCommandline()));
throw new CommandLineException(msg.toString());
}

if (StringUtils.isNotEmpty(err.getOutput())) {
return JavaVersion.parse(extractJavadocVersion(err.getOutput()));
} else if (StringUtils.isNotEmpty(out.getOutput())) {
return JavaVersion.parse(extractJavadocVersion(out.getOutput()));
if (!errOutput.isEmpty()) {
return JavaVersion.parse(extractJavadocVersion(errOutput));
} else {
String outOutput = out.getOutput(); // non-null
if (!outOutput.isEmpty()) {
return JavaVersion.parse(extractJavadocVersion(outOutput));
}
}

throw new IllegalArgumentException("No output found from the command line 'javadoc -J-version'");
Expand Down Expand Up @@ -881,7 +881,7 @@ protected static String unifyPathSeparator(final String path) {
return null;
}

return StringUtils.join(splitPath(path), File.pathSeparator);
return String.join(File.pathSeparator, splitPath(path));
}

// ----------------------------------------------------------------------
Expand Down Expand Up @@ -1494,14 +1494,19 @@ private static CloseableHttpClient createHttpClient(Settings settings, URL url)
ProxyInfo proxyInfo = new ProxyInfo();
proxyInfo.setNonProxyHosts(activeProxy.getNonProxyHosts());

if (StringUtils.isNotEmpty(activeProxy.getHost())
String activeProxyHost = activeProxy.getHost();
if (activeProxyHost != null
&& !activeProxyHost.isEmpty()
&& (url == null || !ProxyUtils.validateNonProxyHosts(proxyInfo, url.getHost()))) {
HttpHost proxy = new HttpHost(activeProxy.getHost(), activeProxy.getPort());
builder.setProxy(proxy);

if (StringUtils.isNotEmpty(activeProxy.getUsername()) && activeProxy.getPassword() != null) {
String activeProxyUsername = activeProxy.getUsername();
if (activeProxyUsername != null
&& !activeProxyUsername.isEmpty()
&& activeProxy.getPassword() != null) {
Credentials credentials =
new UsernamePasswordCredentials(activeProxy.getUsername(), activeProxy.getPassword());
new UsernamePasswordCredentials(activeProxyUsername, activeProxy.getPassword());

CredentialsProvider credentialsProvider = new BasicCredentialsProvider();
credentialsProvider.setCredentials(AuthScope.ANY, credentials);
Expand Down