Oracle javadoc guidelines (#1582)

* Oracle javdoc guidelines

* spotless

Author: elharo

maven-resolver-util/src/main/java/org/eclipse/aether/util/ChecksumUtils.java

@@ -35,7 +35,7 @@
 /**
  * A utility class to assist in the verification and generation of checksums.
  *
- * @deprecated The use of class should be avoided, see {@link StringDigestUtil} and file processor in SPI module.
+ * @deprecated the use of class should be avoided, see {@link StringDigestUtil} and file processor in SPI module
  */
 @Deprecated
 public final class ChecksumUtils {
@@ -47,10 +47,10 @@ private ChecksumUtils() {
     /**
      * Extracts the checksum from the specified file.
      *
-     * @param checksumFile The path to the checksum file, must not be {@code null}.
-     * @return The checksum stored in the file, never {@code null}.
-     * @throws IOException If the checksum does not exist or could not be read for other reasons.
-     * @deprecated Use SPI FileProcessor to read and write checksum files.
+     * @param checksumFile the path to the checksum file, must not be {@code null}
+     * @return the checksum stored in the file, never {@code null}
+     * @throws IOException if the checksum does not exist or could not be read for other reasons
+     * @deprecated use SPI FileProcessor to read and write checksum files
      */
     @Deprecated
     public static String read(File checksumFile) throws IOException {
@@ -87,21 +87,21 @@ public static String read(File checksumFile) throws IOException {
     /**
      * Calculates checksums for the specified file.
      *
-     * @param dataFile The file for which to calculate checksums, must not be {@code null}.
-     * @param algos The names of checksum algorithms (cf. {@link MessageDigest#getInstance(String)} to use, must not be
+     * @param dataFile the file for which to calculate checksums, must not be {@code null}
+     * @param algos the names of checksum algorithms (cf. {@link MessageDigest#getInstance(String)} to use, must not be
      *            {@code null}.
-     * @return The calculated checksums, indexed by algorithm name, or the exception that occurred while trying to
-     *         calculate it, never {@code null}.
-     * @throws IOException If the data file could not be read.
-     * @deprecated Use SPI checksum selector instead.
+     * @return the calculated checksums, indexed by algorithm name, or the exception that occurred while trying to
+     *         calculate it, never {@code null}
+     * @throws IOException if the data file could not be read
+     * @deprecated use SPI checksum selector instead
      */
     @Deprecated
     public static Map<String, Object> calc(File dataFile, Collection<String> algos) throws IOException {
         return calc(new FileInputStream(dataFile), algos);
     }
 
     /**
-     * @deprecated Use SPI checksum selector instead.
+     * @deprecated use SPI checksum selector instead
      */
     @Deprecated
     public static Map<String, Object> calc(byte[] dataBytes, Collection<String> algos) throws IOException {
@@ -145,8 +145,8 @@ private static Map<String, Object> calc(InputStream data, Collection<String> alg
      * Creates a hexadecimal representation of the specified bytes. Each byte is converted into a two-digit hex number
      * and appended to the result with no separator between consecutive bytes.
      *
-     * @param bytes The bytes to represent in hex notation, may be be {@code null}.
-     * @return The hexadecimal representation of the input or {@code null} if the input was {@code null}.
+     * @param bytes the bytes to represent in hex notation, may be be {@code null}
+     * @return the hexadecimal representation of the input or {@code null} if the input was {@code null}
      */
     public static String toHexString(byte[] bytes) {
         return StringDigestUtil.toHexString(bytes);
@@ -156,8 +156,8 @@ public static String toHexString(byte[] bytes) {
      * Creates a byte array out of hexadecimal representation of the specified bytes. If input string is {@code null},
      * {@code null} is returned. Input value must have even length (due hex encoding = 2 chars one byte).
      *
-     * @param hexString The hexString to convert to byte array, may be {@code null}.
-     * @return The byte array of the input or {@code null} if the input was {@code null}.
+     * @param hexString the hexString to convert to byte array, may be {@code null}
+     * @return the byte array of the input or {@code null} if the input was {@code null}
      * @since 1.8.0
      */
     public static byte[] fromHexString(String hexString) {

maven-resolver-util/src/main/java/org/eclipse/aether/util/ConfigUtils.java

@@ -54,11 +54,11 @@ private DirectoryUtils() {
      * Resulting path is being checked is a directory, and if not, it will be created if {@code mayCreate} is
      * {@code true}. If resulting path exist but is not a directory, this method will throw.
      *
-     * @param name      The name to create directory with, cannot be {@code null}.
-     * @param base      The base {@link Path} to resolve name, if it is relative path, cannot be {@code null}.
-     * @param mayCreate If resulting path does not exist, should it create?
-     * @return The {@link Path} instance that is resolved and backed by existing directory.
-     * @throws IOException If some IO related errors happens.
+     * @param name      the name to create directory with, cannot be {@code null}
+     * @param base      the base {@link Path} to resolve name, if it is relative path, cannot be {@code null}
+     * @param mayCreate if resulting path does not exist, should it create?
+     * @return the {@link Path} instance that is resolved and backed by existing directory
+     * @throws IOException if some IO related errors happens
      */
     public static Path resolveDirectory(String name, Path base, boolean mayCreate) throws IOException {
         requireNonNull(name, "name is null");
@@ -88,12 +88,12 @@ public static Path resolveDirectory(String name, Path base, boolean mayCreate) t
      * For this method to work, {@link LocalRepository#getBasePath()} must return
      * non-{@code null} value, otherwise {@link NullPointerException} is thrown.
      *
-     * @param session     The session, may not be {@code null}.
-     * @param defaultName The default value if not present in session configuration, may not be {@code null}.
-     * @param nameKey     The key to look up for in session configuration to obtain user set value.
-     * @param mayCreate   If resulting path does not exist, should it create?
-     * @return The {@link Path} instance that is resolved and backed by existing directory.
-     * @throws IOException If some IO related errors happens.
+     * @param session     the session, may not be {@code null}
+     * @param defaultName the default value if not present in session configuration, may not be {@code null}
+     * @param nameKey     the key to look up for in session configuration to obtain user set value
+     * @param mayCreate   if resulting path does not exist, should it create?
+     * @return the {@link Path} instance that is resolved and backed by existing directory
+     * @throws IOException if some IO related errors happens
      * @see #resolveDirectory(String, Path, boolean)
      */
     public static Path resolveDirectory(

maven-resolver-util/src/main/java/org/eclipse/aether/util/DirectoryUtils.java

@@ -171,9 +171,9 @@ public interface FileWriter {
     /**
      * Writes file without backup.
      *
-     * @param target that is the target file (must be file, the path must have parent).
-     * @param writer the writer that will accept a {@link Path} to write content to.
-     * @throws IOException if at any step IO problem occurs.
+     * @param target that is the target file (must be file, the path must have parent)
+     * @param writer the writer that will accept a {@link Path} to write content to
+     * @throws IOException if at any step IO problem occurs
      */
     public static void writeFile(Path target, FileWriter writer) throws IOException {
         writeFile(target, writer, false);
@@ -182,9 +182,9 @@ public static void writeFile(Path target, FileWriter writer) throws IOException
     /**
      * Writes file with backup copy (appends ".bak" extension).
      *
-     * @param target that is the target file (must be file, the path must have parent).
-     * @param writer the writer that will accept a {@link Path} to write content to.
-     * @throws IOException if at any step IO problem occurs.
+     * @param target that is the target file (must be file, the path must have parent)
+     * @param writer the writer that will accept a {@link Path} to write content to
+     * @throws IOException if at any step IO problem occurs
      */
     public static void writeFileWithBackup(Path target, FileWriter writer) throws IOException {
         writeFile(target, writer, true);
@@ -195,11 +195,11 @@ public static void writeFileWithBackup(Path target, FileWriter writer) throws IO
      * ensures that no other thread or process will be able to read not fully written files. Finally, this method
      * may create the needed parent directories, if the passed in target parents does not exist.
      *
-     * @param target   that is the target file (must be an existing or non-existing file, the path must have parent).
-     * @param writer   the writer that will accept a {@link Path} to write content to.
+     * @param target   that is the target file (must be an existing or non-existing file, the path must have parent)
+     * @param writer   the writer that will accept a {@link Path} to write content to
      * @param doBackup if {@code true}, and target file is about to be overwritten, a ".bak" file with old contents will
-     *                 be created/overwritten.
-     * @throws IOException if at any step IO problem occurs.
+     *                 be created/overwritten
+     * @throws IOException if at any step IO problem occurs
      */
     private static void writeFile(Path target, FileWriter writer, boolean doBackup) throws IOException {
         requireNonNull(target, "target is null");

maven-resolver-util/src/main/java/org/eclipse/aether/util/FileUtils.java

@@ -84,8 +84,8 @@ public static String sha1(final String string) {
      * Creates a hexadecimal representation of the specified bytes. Each byte is converted into a two-digit hex number
      * and appended to the result with no separator between consecutive bytes.
      *
-     * @param bytes The bytes to represent in hex notation, may be {@code null}.
-     * @return The hexadecimal representation of the input or {@code null} if the input was {@code null}.
+     * @param bytes the bytes to represent in hex notation, may be {@code null}
+     * @return the hexadecimal representation of the input or {@code null} if the input was {@code null}
      * @since 2.0.0
      */
     public static String toHexString(byte[] bytes) {
@@ -110,8 +110,8 @@ public static String toHexString(byte[] bytes) {
      * Creates a byte array out of hexadecimal representation of the specified bytes. If input string is {@code null},
      * {@code null} is returned. Input value must have even length (due hex encoding = 2 chars one byte).
      *
-     * @param hexString The hexString to convert to byte array, may be {@code null}.
-     * @return The byte array of the input or {@code null} if the input was {@code null}.
+     * @param hexString the hexString to convert to byte array, may be {@code null}
+     * @return the byte array of the input or {@code null} if the input was {@code null}
      * @since 2.0.0
      */
     public static byte[] fromHexString(String hexString) {

maven-resolver-util/src/main/java/org/eclipse/aether/util/StringDigestUtil.java

@@ -36,8 +36,8 @@ private ArtifactIdUtils() {
     /**
      * Creates an artifact identifier of the form {@code <groupId>:<artifactId>:<extension>[:<classifier>]:<version>}.
      *
-     * @param artifact The artifact to create an identifer for, may be {@code null}.
-     * @return The artifact identifier or {@code null} if the input was {@code null}.
+     * @param artifact the artifact to create an identifer for, may be {@code null}
+     * @return the artifact identifier or {@code null} if the input was {@code null}
      */
     public static String toId(Artifact artifact) {
         String id = null;
@@ -55,12 +55,12 @@ public static String toId(Artifact artifact) {
     /**
      * Creates an artifact identifier of the form {@code <groupId>:<artifactId>:<extension>[:<classifier>]:<version>}.
      *
-     * @param groupId The group id, may be {@code null}.
-     * @param artifactId The artifact id, may be {@code null}.
-     * @param extension The file extensiion, may be {@code null}.
-     * @param classifier The classifier, may be {@code null}.
-     * @param version The version, may be {@code null}.
-     * @return The artifact identifier, never {@code null}.
+     * @param groupId the group id, may be {@code null}
+     * @param artifactId the artifact id, may be {@code null}
+     * @param extension the file extensiion, may be {@code null}
+     * @param classifier the classifier, may be {@code null}
+     * @param version the version, may be {@code null}
+     * @return the artifact identifier, never {@code null}
      */
     public static String toId(String groupId, String artifactId, String extension, String classifier, String version) {
         StringBuilder buffer = concat(groupId, artifactId, extension, classifier);
@@ -75,8 +75,8 @@ public static String toId(String groupId, String artifactId, String extension, S
      * Creates an artifact identifier of the form
      * {@code <groupId>:<artifactId>:<extension>[:<classifier>]:<baseVersion>}.
      *
-     * @param artifact The artifact to create an identifer for, may be {@code null}.
-     * @return The artifact identifier or {@code null} if the input was {@code null}.
+     * @param artifact the artifact to create an identifer for, may be {@code null}
+     * @return the artifact identifier or {@code null} if the input was {@code null}
      */
     public static String toBaseId(Artifact artifact) {
         String id = null;
@@ -94,8 +94,8 @@ public static String toBaseId(Artifact artifact) {
     /**
      * Creates an artifact identifier of the form {@code <groupId>:<artifactId>:<extension>[:<classifier>]}.
      *
-     * @param artifact The artifact to create an identifer for, may be {@code null}.
-     * @return The artifact identifier or {@code null} if the input was {@code null}.
+     * @param artifact the artifact to create an identifer for, may be {@code null}
+     * @return the artifact identifier or {@code null} if the input was {@code null}
      */
     public static String toVersionlessId(Artifact artifact) {
         String id = null;
@@ -109,11 +109,11 @@ public static String toVersionlessId(Artifact artifact) {
     /**
      * Creates an artifact identifier of the form {@code <groupId>:<artifactId>:<extension>[:<classifier>]}.
      *
-     * @param groupId The group id, may be {@code null}.
-     * @param artifactId The artifact id, may be {@code null}.
-     * @param extension The file extensiion, may be {@code null}.
-     * @param classifier The classifier, may be {@code null}.
-     * @return The artifact identifier, never {@code null}.
+     * @param groupId the group id, may be {@code null}
+     * @param artifactId the artifact id, may be {@code null}
+     * @param extension the file extensiion, may be {@code null}
+     * @param classifier the classifier, may be {@code null}
+     * @return the artifact identifier, never {@code null}
      */
     public static String toVersionlessId(String groupId, String artifactId, String extension, String classifier) {
         return concat(groupId, artifactId, extension, classifier).toString();
@@ -145,9 +145,9 @@ private static StringBuilder concat(String groupId, String artifactId, String ex
      * {@link String#equals(Object)} on the return values from {@link #toId(Artifact)} for the artifacts but does not
      * incur the overhead of creating temporary strings.
      *
-     * @param artifact1 The first artifact, may be {@code null}.
-     * @param artifact2 The second artifact, may be {@code null}.
-     * @return {@code true} if both artifacts are not {@code null} and have equal ids, {@code false} otherwise.
+     * @param artifact1 the first artifact, may be {@code null}
+     * @param artifact2 the second artifact, may be {@code null}
+     * @return {@code true} if both artifacts are not {@code null} and have equal ids, {@code false} otherwise
      */
     public static boolean equalsId(Artifact artifact1, Artifact artifact2) {
         if (artifact1 == null || artifact2 == null) {
@@ -173,9 +173,9 @@ public static boolean equalsId(Artifact artifact1, Artifact artifact2) {
      * {@link String#equals(Object)} on the return values from {@link #toBaseId(Artifact)} for the artifacts but does
      * not incur the overhead of creating temporary strings.
      *
-     * @param artifact1 The first artifact, may be {@code null}.
-     * @param artifact2 The second artifact, may be {@code null}.
-     * @return {@code true} if both artifacts are not {@code null} and have equal base ids, {@code false} otherwise.
+     * @param artifact1 the first artifact, may be {@code null}
+     * @param artifact2 the second artifact, may be {@code null}
+     * @return {@code true} if both artifacts are not {@code null} and have equal base ids, {@code false} otherwise
      */
     public static boolean equalsBaseId(Artifact artifact1, Artifact artifact2) {
         if (artifact1 == null || artifact2 == null) {
@@ -201,10 +201,10 @@ public static boolean equalsBaseId(Artifact artifact1, Artifact artifact2) {
      * {@link String#equals(Object)} on the return values from {@link #toVersionlessId(Artifact)} for the artifacts but
      * does not incur the overhead of creating temporary strings.
      *
-     * @param artifact1 The first artifact, may be {@code null}.
-     * @param artifact2 The second artifact, may be {@code null}.
+     * @param artifact1 the first artifact, may be {@code null}
+     * @param artifact2 the second artifact, may be {@code null}
      * @return {@code true} if both artifacts are not {@code null} and have equal versionless ids, {@code false}
-     *         otherwise.
+     *         otherwise
      */
     public static boolean equalsVersionlessId(Artifact artifact1, Artifact artifact2) {
         if (artifact1 == null || artifact2 == null) {

maven-resolver-util/src/main/java/org/eclipse/aether/util/artifact/ArtifactIdUtils.java

@@ -34,8 +34,8 @@ public DefaultArtifactTypeRegistry() {}
     /**
      * Adds the specified artifact type to the registry.
      *
-     * @param type The artifact type to add, must not be {@code null}.
-     * @return This registry for chaining, never {@code null}.
+     * @param type the artifact type to add, must not be {@code null}
+     * @return this registry for chaining, never {@code null}
      */
     @Override
     public DefaultArtifactTypeRegistry add(ArtifactType type) {

maven-resolver-util/src/main/java/org/eclipse/aether/util/artifact/DefaultArtifactTypeRegistry.java

@@ -38,7 +38,7 @@ public abstract class DelegatingArtifact extends AbstractArtifact {
     /**
      * Creates a new artifact instance that delegates to the specified artifact.
      *
-     * @param delegate The artifact to delegate to, must not be {@code null}.
+     * @param delegate the artifact to delegate to, must not be {@code null}
      */
     protected DelegatingArtifact(Artifact delegate) {
         this.delegate = requireNonNull(delegate, "delegate artifact cannot be null");
@@ -48,8 +48,8 @@ protected DelegatingArtifact(Artifact delegate) {
      * Creates a new artifact instance that delegates to the specified artifact. Subclasses should use this hook to
      * instantiate themselves, taking along any data from the current instance that was added.
      *
-     * @param delegate The artifact to delegate to, must not be {@code null}.
-     * @return The new delegating artifact, never {@code null}.
+     * @param delegate the artifact to delegate to, must not be {@code null}
+     * @return the new delegating artifact, never {@code null}
      */
     protected abstract DelegatingArtifact newInstance(Artifact delegate);
 

maven-resolver-util/src/main/java/org/eclipse/aether/util/artifact/DelegatingArtifact.java

@@ -22,8 +22,7 @@
  * The dependency scopes used for Java dependencies.
  *
  * @see org.eclipse.aether.graph.Dependency#getScope()
- *
- * @deprecated Definition and semantics of the scopes should be defined by consumer project.
+ * @deprecated definition and semantics of the scopes should be defined by consumer project
  */
 @Deprecated
 public final class JavaScopes {