diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/Artifact.java b/api/maven-api-core/src/main/java/org/apache/maven/api/Artifact.java index 5ebbc9783d0e..d222789f7ad3 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/Artifact.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/Artifact.java @@ -35,7 +35,8 @@ public interface Artifact /** * Returns a unique identifier for this artifact. - * The identifier is composed of groupId, artifactId, version, classifier, extension + * The identifier is composed of groupId, artifactId, version, classifier, extension. + * * @return the unique identifier */ default String key() @@ -50,7 +51,7 @@ default String key() /** * The groupId of the artifact. * - * @return The groupId. + * @return the groupId */ @Nonnull String getGroupId(); @@ -58,7 +59,7 @@ default String key() /** * The artifactId of the artifact. * - * @return The artifactId. + * @return the artifactId */ @Nonnull String getArtifactId(); @@ -66,7 +67,7 @@ default String key() /** * The version of the artifact. * - * @return The version. + * @return the version */ @Nonnull Version getVersion(); @@ -74,7 +75,7 @@ default String key() /** * The classifier of the artifact. * - * @return The classifier or an empty string if none, never {@code null}. + * @return the classifier or an empty string if none, never {@code null} */ @Nonnull String getClassifier(); @@ -82,7 +83,7 @@ default String key() /** * The file extension of the artifact. * - * @return The extension. + * @return the extension */ @Nonnull String getExtension(); @@ -90,7 +91,7 @@ default String key() /** * Determines whether this artifact uses a snapshot version. * - * @return {@code true} if the artifact is a snapshot, {@code false} otherwise. + * @return {@code true} if the artifact is a snapshot, {@code false} otherwise * @see org.apache.maven.api.Session#isVersionSnapshot(String) */ boolean isSnapshot(); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/ArtifactCoordinate.java b/api/maven-api-core/src/main/java/org/apache/maven/api/ArtifactCoordinate.java index 1f11e321986f..3e66594dfad5 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/ArtifactCoordinate.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/ArtifactCoordinate.java @@ -37,7 +37,7 @@ public interface ArtifactCoordinate /** * The groupId of the artifact. * - * @return The groupId. + * @return the groupId */ @Nonnull String getGroupId(); @@ -45,7 +45,7 @@ public interface ArtifactCoordinate /** * The artifactId of the artifact. * - * @return The artifactId. + * @return the artifactId */ @Nonnull String getArtifactId(); @@ -53,7 +53,7 @@ public interface ArtifactCoordinate /** * The classifier of the artifact. * - * @return The classifier or an empty string if none, never {@code null}. + * @return the classifier or an empty string if none, never {@code null} */ @Nonnull String getClassifier(); @@ -61,7 +61,7 @@ public interface ArtifactCoordinate /** * The version of the artifact. * - * @return The version. + * @return the version */ @Nonnull VersionRange getVersion(); @@ -69,7 +69,7 @@ public interface ArtifactCoordinate /** * The extension of the artifact. * - * @return The extension or an empty string if none, never {@code null}. + * @return the extension or an empty string if none, never {@code null} */ @Nonnull String getExtension(); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/Dependency.java b/api/maven-api-core/src/main/java/org/apache/maven/api/Dependency.java index c3844398c15b..86c4cb4e24c9 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/Dependency.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/Dependency.java @@ -27,7 +27,7 @@ public interface Dependency extends Artifact /** * The artifact type. * - * @return The artifact type, never {@code null}. + * @return the artifact type, never {@code null} */ @Nonnull Type getType(); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/DependencyCoordinate.java b/api/maven-api-core/src/main/java/org/apache/maven/api/DependencyCoordinate.java index e5ea7a4cb6c2..675a00f0d374 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/DependencyCoordinate.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/DependencyCoordinate.java @@ -37,7 +37,7 @@ public interface DependencyCoordinate extends ArtifactCoordinate /** * The type of the artifact. * - * @return The type. + * @return the type */ @Nonnull Type getType(); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/Event.java b/api/maven-api-core/src/main/java/org/apache/maven/api/Event.java index 0a30dba8fd51..4d23939a7c6b 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/Event.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/Event.java @@ -38,7 +38,7 @@ public interface Event /** * Gets the type of the event. * - * @return The type of the event, never {@code null}. + * @return the type of the event, never {@code null} */ @Nonnull EventType getType(); @@ -46,7 +46,7 @@ public interface Event /** * Gets the session from which this event originates. * - * @return The current session, never {@code null}. + * @return the current session, never {@code null} */ @Nonnull Session getSession(); @@ -54,7 +54,7 @@ public interface Event /** * Gets the current project (if any). * - * @return The current project or {@code empty()} if not applicable. + * @return the current project or {@code empty()} if not applicable */ @Nonnull Optional getProject(); @@ -62,7 +62,7 @@ public interface Event /** * Gets the current mojo execution (if any). * - * @return The current mojo execution or {@code empty()} if not applicable. + * @return the current mojo execution or {@code empty()} if not applicable */ @Nonnull Optional getMojoExecution(); @@ -70,7 +70,7 @@ public interface Event /** * Gets the exception that caused the event (if any). * - * @return The exception or {@code empty()} if none. + * @return the exception or {@code empty()} if none */ Optional getException(); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/Node.java b/api/maven-api-core/src/main/java/org/apache/maven/api/Node.java index f0bb78b17353..d23c8f60e74b 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/Node.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/Node.java @@ -67,8 +67,8 @@ public interface Node /** * Traverses this node and potentially its children using the specified visitor. * - * @param visitor The visitor to call back, must not be {@code null}. - * @return {@code true} to visit siblings nodes of this node as well, {@code false} to skip siblings. + * @param visitor the visitor to call back, must not be {@code null} + * @return {@code true} to visit siblings nodes of this node as well, {@code false} to skip siblings */ boolean accept( @Nonnull NodeVisitor visitor ); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/Repository.java b/api/maven-api-core/src/main/java/org/apache/maven/api/Repository.java index 10551d737c5d..896943d197a1 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/Repository.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/Repository.java @@ -38,7 +38,7 @@ public interface Repository /** * Gets the identifier of this repository. * - * @return The (case-sensitive) identifier, never {@code null}. + * @return the (case-sensitive) identifier, never {@code null} */ @Nonnull String getId(); @@ -46,7 +46,7 @@ public interface Repository /** * Gets the type of the repository, for example "default". * - * @return The (case-sensitive) type of the repository, never {@code null}. + * @return the (case-sensitive) type of the repository, never {@code null} */ @Nonnull String getType(); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/Session.java b/api/maven-api-core/src/main/java/org/apache/maven/api/Session.java index 758d227f1dcb..28556d86a282 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/Session.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/Session.java @@ -56,15 +56,27 @@ public interface Session @Nonnull SessionData getData(); + /** + * Gets the user properties to use for interpolation. The user properties have been configured directly by the user, + * e.g. via the {@code -Dkey=value} parameter on the command line. + * + * @return the user properties, never {@code null} + */ @Nonnull Map getUserProperties(); + /** + * Gets the system properties to use for interpolation. The system properties are collected from the runtime + * environment such as {@link System#getProperties()} and environment variables. + * + * @return the system properties, never {@code null} + */ @Nonnull Map getSystemProperties(); /** * Returns the current maven version - * @return the maven version, never {@code null}. + * @return the maven version, never {@code null} */ @Nonnull String getMavenVersion(); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/SessionData.java b/api/maven-api-core/src/main/java/org/apache/maven/api/SessionData.java index 8a8ef19401f0..2df695ec3fba 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/SessionData.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/SessionData.java @@ -47,8 +47,8 @@ public interface SessionData /** * Associates the specified session data with the given key. * - * @param key The key under which to store the session data, must not be {@code null}. - * @param value The data to associate with the key, may be {@code null} to remove the mapping. + * @param key the key under which to store the session data, must not be {@code null} + * @param value the data to associate with the key, may be {@code null} to remove the mapping */ void set( @Nonnull Object key, @Nullable Object value ); @@ -56,9 +56,9 @@ public interface SessionData * Associates the specified session data with the given key if the key is currently mapped to the given value. This * method provides an atomic compare-and-update of some key's value. * - * @param key The key under which to store the session data, must not be {@code null}. - * @param oldValue The expected data currently associated with the key, may be {@code null}. - * @param newValue The data to associate with the key, may be {@code null} to remove the mapping. + * @param key the key under which to store the session data, must not be {@code null} + * @param oldValue the expected data currently associated with the key, may be {@code null} + * @param newValue the data to associate with the key, may be {@code null} to remove the mapping * @return {@code true} if the key mapping was successfully updated from the old value to the new value, * {@code false} if the current key mapping didn't match the expected value and was not updated. */ @@ -67,8 +67,8 @@ public interface SessionData /** * Gets the session data associated with the specified key. * - * @param key The key for which to retrieve the session data, must not be {@code null}. - * @return The session data associated with the key or {@code null} if none. + * @param key the key for which to retrieve the session data, must not be {@code null} + * @return the session data associated with the key or {@code null} if none */ @Nullable Object get( @Nonnull Object key ); @@ -76,9 +76,9 @@ public interface SessionData /** * Retrieve of compute the data associated with the specified key. * - * @param key The key for which to retrieve the session data, must not be {@code null}. - * @param supplier The supplier will compute the new value. - * @return The session data associated with the key. + * @param key the key for which to retrieve the session data, must not be {@code null} + * @param supplier the supplier will compute the new value + * @return the session data associated with the key */ @Nullable Object computeIfAbsent( @Nonnull Object key, @Nonnull Supplier supplier ); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/Toolchain.java b/api/maven-api-core/src/main/java/org/apache/maven/api/Toolchain.java index 1d013ff19354..3bc15e48f650 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/Toolchain.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/Toolchain.java @@ -41,7 +41,7 @@ public interface Toolchain /** * Gets the platform tool executable. * - * @param toolName the tool platform independent tool name. + * @param toolName the tool platform independent tool name * @return file representing the tool executable, or null if the tool cannot be found */ String findTool( String toolName ); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/VersionRange.java b/api/maven-api-core/src/main/java/org/apache/maven/api/VersionRange.java index fb3e39b2f630..83117b6813b3 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/VersionRange.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/VersionRange.java @@ -36,8 +36,8 @@ public interface VersionRange /** * Determines whether the specified version is contained within this range. * - * @param version The version to test, must not be {@code null}. - * @return {@code true} if this range contains the specified version, {@code false} otherwise. + * @param version the version to test, must not be {@code null} + * @return {@code true} if this range contains the specified version, {@code false} otherwise */ boolean contains( @Nonnull Version version ); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/plugin/Mojo.java b/api/maven-api-core/src/main/java/org/apache/maven/api/plugin/Mojo.java index a6217bff2a96..384616d2ab53 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/plugin/Mojo.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/plugin/Mojo.java @@ -39,7 +39,7 @@ public interface Mojo * This is the main trigger for the Mojo inside the Maven system, and allows * the Mojo to communicate errors. * - * @throws MojoException if a problem occurs. + * @throws MojoException if a problem occurs */ void execute(); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/plugin/MojoException.java b/api/maven-api-core/src/main/java/org/apache/maven/api/plugin/MojoException.java index 5e5b0c7eee1c..96852dc2c5df 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/plugin/MojoException.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/plugin/MojoException.java @@ -37,7 +37,7 @@ public class MojoException protected String longMessage; /** - * Construct a new MojoExecutionException exception providing the source and a short and long message: + * Construct a new MojoException exception providing the source and a short and long message: * these messages are used to improve the message written at the end of Maven build. */ public MojoException( Object source, String shortMessage, String longMessage ) diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactDeployerException.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactDeployerException.java index fbb206a53489..9fba9f02628b 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactDeployerException.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactDeployerException.java @@ -37,7 +37,7 @@ public class ArtifactDeployerException private static final long serialVersionUID = 7421964724059077698L; /** - * @param message The message of the error. + * @param message the message of the error * @param e {@link Exception} */ public ArtifactDeployerException( String message, Exception e ) diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstaller.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstaller.java index 937af56607f2..35046c6d3f5a 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstaller.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstaller.java @@ -38,8 +38,8 @@ public interface ArtifactInstaller extends Service { /** * @param request {@link ArtifactInstallerRequest} - * @throws ArtifactInstallerException in case of an error. - * @throws IllegalArgumentException in case {@code request} is {@code null}. + * @throws ArtifactInstallerException in case of an error + * @throws IllegalArgumentException in case {@code request} is {@code null} */ void install( ArtifactInstallerRequest request ); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstallerException.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstallerException.java index e6c6dc6abd81..d045a5f82a73 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstallerException.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstallerException.java @@ -35,7 +35,7 @@ public class ArtifactInstallerException private static final long serialVersionUID = 3652561971360586373L; /** - * @param message The message of the error. + * @param message the message of the error * @param e {@link Exception} */ public ArtifactInstallerException( String message, Exception e ) diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactResolver.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactResolver.java index 99f49d241d2b..b695bb24e8e7 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactResolver.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactResolver.java @@ -38,9 +38,9 @@ public interface ArtifactResolver extends Service /** * @param request {@link ArtifactResolverRequest} * @return {@link ArtifactResolverResult} - * @throws ArtifactResolverException in case of an error. + * @throws ArtifactResolverException in case of an error * @throws IllegalArgumentException in case of parameter {@code buildingRequest} is {@code null} or - * parameter {@code mavenArtifact} is {@code null} or invalid. + * parameter {@code mavenArtifact} is {@code null} or invalid */ ArtifactResolverResult resolve( ArtifactResolverRequest request ); @@ -50,7 +50,7 @@ public interface ArtifactResolver extends Service * @return {@link ArtifactResolverResult} * @throws ArtifactResolverException in case of an error. * @throws IllegalArgumentException in case of parameter {@code buildingRequest} is {@code null} or - * parameter {@code coordinate} is {@code null} or invalid. + * parameter {@code coordinate} is {@code null} or invalid */ default ArtifactResolverResult resolve( Session session, Collection coordinates ) diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactResolverException.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactResolverException.java index ba6e5482cf34..2928c984d90d 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactResolverException.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactResolverException.java @@ -34,8 +34,8 @@ public class ArtifactResolverException private static final long serialVersionUID = 7252294837746943917L; /** - * @param message The message for the exception. - * @param e The exception itself. + * @param message the message for the exception + * @param e the exception itself */ public ArtifactResolverException( String message, Exception e ) { diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollector.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollector.java index e21b2c46925d..a8a651c38911 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollector.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollector.java @@ -45,9 +45,9 @@ public interface DependencyCollector extends Service * Note that this operation is only concerned about determining the coordinates of the * transitive dependencies and does not actually resolve the artifact files. * - * @param request The dependency collection request, must not be {@code null}. - * @return The collection result, never {@code null}. - * @throws DependencyCollectorException If the dependency tree could not be built. + * @param request the dependency collection request, must not be {@code null} + * @return the collection result, never {@code null} + * @throws DependencyCollectorException if the dependency tree could not be built * @throws IllegalArgumentException if an argument is null or invalid * * @see DependencyCollector#collect(Session, Project) @@ -62,10 +62,10 @@ public interface DependencyCollector extends Service * only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the * artifact files. * - * @param session The {@link Session}, must not be {@code null}. - * @param root The Maven Dependency, must not be {@code null}. - * @return The collection result, never {@code null}. - * @throws DependencyCollectorException If the dependency tree could not be built. + * @param session the {@link Session}, must not be {@code null} + * @param root the Maven Dependency, must not be {@code null} + * @return the collection result, never {@code null} + * @throws DependencyCollectorException if the dependency tree could not be built * @throws IllegalArgumentException if an argument is null or invalid * @see #collect(DependencyCollectorRequest) */ @@ -81,10 +81,10 @@ default DependencyCollectorResult collect( @Nonnull Session session, * only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the * artifact files. * - * @param session The {@link Session}, must not be {@code null}. - * @param project The {@link Project}, must not be {@code null}. - * @return The collection result, never {@code null}. - * @throws DependencyCollectorException If the dependency tree could not be built. + * @param session the {@link Session}, must not be {@code null} + * @param project the {@link Project}, must not be {@code null} + * @return the collection result, never {@code null} + * @throws DependencyCollectorException if the dependency tree could not be built * @throws IllegalArgumentException if an argument is null or invalid * @see #collect(DependencyCollectorRequest) */ @@ -100,10 +100,10 @@ default DependencyCollectorResult collect( @Nonnull Session session, * only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the * artifact files. * - * @param session The {@link Session}, must not be {@code null}. - * @param artifact The {@link Artifact}, must not be {@code null}. - * @return The collection result, never {@code null}. - * @throws DependencyCollectorException If the dependency tree could not be built. + * @param session the {@link Session}, must not be {@code null} + * @param artifact the {@link Artifact}, must not be {@code null} + * @return the collection result, never {@code null} + * @throws DependencyCollectorException if the dependency tree could not be built * @throws IllegalArgumentException if an argument is null or invalid * @see #collect(DependencyCollectorRequest) */ diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollectorException.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollectorException.java index 019fedb6b31b..d173c0f789f3 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollectorException.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollectorException.java @@ -37,8 +37,8 @@ public class DependencyCollectorException private static final long serialVersionUID = -3134726259840210686L; /** - * @param message The message you would give for the exception. - * @param cause The cause which is related to the message. + * @param message the message you would give for the exception + * @param cause the cause which is related to the message */ public DependencyCollectorException( String message, Throwable cause ) { diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollectorRequest.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollectorRequest.java index 345db90bac5f..f94b1e9a1a13 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollectorRequest.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollectorRequest.java @@ -134,8 +134,8 @@ public DependencyCollectorRequestBuilder session( @Nonnull Session session ) * as a label for the root node of the graph in case no root dependency was specified. As such, the configured * root artifact is ignored if {@link #root(DependencyCoordinate)} has been set. * - * @param rootArtifact The root artifact for the dependency graph, may be {@code null}. - * @return This request for chaining, never {@code null}. + * @param rootArtifact the root artifact for the dependency graph, may be {@code null} + * @return this request for chaining, never {@code null} */ @Nonnull public DependencyCollectorRequestBuilder rootArtifact( @Nullable Artifact rootArtifact ) @@ -146,7 +146,7 @@ public DependencyCollectorRequestBuilder rootArtifact( @Nullable Artifact rootAr /** * @param root The root dependency - * @return This request for chaining, never {@code null}. + * @return this request for chaining, never {@code null} */ @Nonnull public DependencyCollectorRequestBuilder root( @Nonnull DependencyCoordinate root ) @@ -160,8 +160,8 @@ public DependencyCollectorRequestBuilder root( @Nonnull DependencyCoordinate roo * direct dependencies from the request will be merged with the direct dependencies from the root dependency's * artifact descriptor, giving higher priority to the dependencies from the request. * - * @param dependencies The direct dependencies, may be {@code null}. - * @return This request for chaining, never {@code null}. + * @param dependencies the direct dependencies, may be {@code null} + * @return this request for chaining, never {@code null} */ @Nonnull public DependencyCollectorRequestBuilder dependencies( @Nullable List dependencies ) @@ -173,8 +173,8 @@ public DependencyCollectorRequestBuilder dependencies( @Nullable List getExceptions(); /** * Gets the root node of the dependency graph. * - * @return The root node of the dependency graph or {@code null} if none. + * @return the root node of the dependency graph or {@code null} if none */ Node getRoot(); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCoordinateFactory.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCoordinateFactory.java index d3c7a6ffd7c3..809a418a136d 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCoordinateFactory.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCoordinateFactory.java @@ -41,7 +41,7 @@ public interface DependencyCoordinateFactory extends Service * Creates a new {@link DependencyCoordinate} object from the request. * * @param request the request containing the various data - * @return a new {@link DependencyCoordinate} object. + * @return a new {@link DependencyCoordinate} object * * @throws IllegalArgumentException if {@code request} is null or * if {@code request.getSession()} is null or invalid diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/LookupException.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/LookupException.java index d88549112e87..abfa15da1716 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/LookupException.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/LookupException.java @@ -31,8 +31,8 @@ public class LookupException extends MavenException { /** - * @param message The message to give. - * @param e The {@link Exception}. + * @param message the message to give + * @param e the {@link Exception} */ public LookupException( String message, Exception e ) { @@ -40,7 +40,7 @@ public LookupException( String message, Exception e ) } /** - * @param e The {@link Exception}. + * @param e the {@link Exception} */ public LookupException( Exception e ) { diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/MessageBuilder.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/MessageBuilder.java index 1d86911995b6..446d0bc692c1 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/MessageBuilder.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/MessageBuilder.java @@ -141,7 +141,7 @@ public interface MessageBuilder * Append formatted content to the buffer. * @see String#format(String, Object...) * @param pattern a format string - * @param args arguments referenced by the format specifiers in the format string. + * @param args arguments referenced by the format specifiers in the format string * @return the current builder */ @Nonnull diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilder.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilder.java index e75ea4af547f..85b9efeeea58 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilder.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilder.java @@ -50,8 +50,8 @@ public interface ProjectBuilder extends Service /** * Creates a {@link org.apache.maven.api.Project} from a POM file. * - * @param session The {@link Session}, must not be {@code null}. - * @param source The {@link ProjectBuilderSource}, must not be {@code null}. + * @param session the {@link Session}, must not be {@code null} + * @param source the {@link ProjectBuilderSource}, must not be {@code null} * @throws ProjectBuilderException if the project cannot be created * @throws IllegalArgumentException if an argument is {@code null} or invalid * @see #build(ProjectBuilderRequest) @@ -65,8 +65,8 @@ default ProjectBuilderResult build( @Nonnull Session session, @Nonnull ProjectBu /** * Creates a {@link org.apache.maven.api.Project} from a POM file. * - * @param session The {@link Session}, must not be {@code null}. - * @param path The {@link Path}, must not be {@code null}. + * @param session the {@link Session}, must not be {@code null} + * @param path the {@link Path}, must not be {@code null} * @throws ProjectBuilderException if the project cannot be created * @throws IllegalArgumentException if an argument is {@code null} or invalid * @see #build(ProjectBuilderRequest) @@ -80,8 +80,8 @@ default ProjectBuilderResult build( @Nonnull Session session, @Nonnull Path path /** * Creates a {@link org.apache.maven.api.Project} from an artifact. * - * @param session The {@link Session}, must not be {@code null}. - * @param artifact The {@link Artifact}, must not be {@code null}. + * @param session the {@link Session}, must not be {@code null} + * @param artifact the {@link Artifact}, must not be {@code null} * @throws ProjectBuilderException if the project cannot be created * @throws IllegalArgumentException if an argument is {@code null} or invalid * @see #build(ProjectBuilderRequest) @@ -95,8 +95,8 @@ default ProjectBuilderResult build( @Nonnull Session session, @Nonnull Artifact /** * Creates a {@link org.apache.maven.api.Project} from a coordinate. * - * @param session The {@link Session}, must not be {@code null}. - * @param coordinate The {@link ArtifactCoordinate}, must not be {@code null}. + * @param session the {@link Session}, must not be {@code null} + * @param coordinate the {@link ArtifactCoordinate}, must not be {@code null} * @throws ProjectBuilderException if the project cannot be created * @throws IllegalArgumentException if an argument is {@code null} or invalid * @see #build(ProjectBuilderRequest) diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderException.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderException.java index 2256bd144611..918913c0a22e 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderException.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderException.java @@ -31,8 +31,8 @@ public class ProjectBuilderException extends MavenException { /** - * @param message The message to give. - * @param e The {@link Exception}. + * @param message the message to give + * @param e the {@link Exception} */ public ProjectBuilderException( String message, Exception e ) { diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderResult.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderResult.java index a76b6cab2ffb..7664da7a1b6c 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderResult.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderResult.java @@ -42,7 +42,7 @@ public interface ProjectBuilderResult * ::} but some of these coordinates may still be unknown at the point the exception * is thrown so this information is merely meant to assist the user. * - * @return The identifier of the project or an empty string if not known, never {@code null}. + * @return the identifier of the project or an empty string if not known, never {@code null} */ @Nonnull String getProjectId(); @@ -50,7 +50,7 @@ public interface ProjectBuilderResult /** * Gets the POM file from which the project was built. * - * @return The optional POM file. + * @return the optional POM file */ @Nonnull Optional getPomFile(); @@ -67,7 +67,7 @@ public interface ProjectBuilderResult /** * Gets the problems that were encountered during the project building. * - * @return The problems that were encountered during the project building, can be empty but never {@code null}. + * @return the problems that were encountered during the project building, can be empty but never {@code null} */ @Nonnull Collection getProblems(); @@ -75,7 +75,7 @@ public interface ProjectBuilderResult /** * Gets the result of the dependency resolution for the project. * - * @return The result of the dependency resolution for the project. + * @return the result of the dependency resolution for the project */ @Nonnull Optional getDependencyResolverResult(); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/PrompterException.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/PrompterException.java index 4f892c749412..9a0de36c2953 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/PrompterException.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/PrompterException.java @@ -31,8 +31,8 @@ public class PrompterException extends MavenException { /** - * @param message The message to give. - * @param e The {@link Exception}. + * @param message the message to give + * @param e the {@link Exception} */ public PrompterException( String message, Exception e ) { diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionParser.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionParser.java index ed5e69ba75c7..700019d715b7 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionParser.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionParser.java @@ -36,9 +36,9 @@ public interface VersionParser extends Service /** * Parses the specified version string, for example "1.0". * - * @param version The version string to parse, must not be {@code null}. - * @return The parsed version, never {@code null}. - * @throws VersionParserException If the string violates the syntax rules of this scheme. + * @param version the version string to parse, must not be {@code null} + * @return the parsed version, never {@code null} + * @throws VersionParserException if the string violates the syntax rules of this scheme * @see org.apache.maven.api.Session#parseVersion(String) */ @Nonnull @@ -47,9 +47,9 @@ public interface VersionParser extends Service /** * Parses the specified version range specification, for example "[1.0,2.0)". * - * @param range The range specification to parse, must not be {@code null}. - * @return The parsed version range, never {@code null}. - * @throws VersionParserException If the range specification violates the syntax rules of this scheme. + * @param range the range specification to parse, must not be {@code null} + * @return the parsed version range, never {@code null} + * @throws VersionParserException if the range specification violates the syntax rules of this scheme */ @Nonnull VersionRange parseVersionRange( @Nonnull String range ); diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionParserException.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionParserException.java index f0c4481132e2..ba016dc0f0e1 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionParserException.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionParserException.java @@ -31,8 +31,8 @@ public class VersionParserException extends MavenException { /** - * @param message The message to give. - * @param e The {@link Exception}. + * @param message the message to give + * @param e the {@link Exception} */ public VersionParserException( String message, Exception e ) { diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderException.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderException.java index 2cc30c0c26cf..23141db4cc9a 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderException.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderException.java @@ -33,8 +33,8 @@ public class XmlReaderException { /** - * @param message The message for the exception. - * @param e The exception itself. + * @param message the message for the exception + * @param e the exception itself */ public XmlReaderException( String message, Exception e ) { diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderRequest.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderRequest.java index 05e4423039bf..086594d62534 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderRequest.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderRequest.java @@ -65,7 +65,7 @@ interface Transformer * @param source The source value * @param fieldName A description of the field being interpolated. The implementation may use this to * log stuff. - * @return The interpolated value. + * @return the interpolated value */ String transform( String source, String fieldName ); } diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlWriterException.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlWriterException.java index 099b6ea12b19..4202ab2ef385 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlWriterException.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlWriterException.java @@ -33,8 +33,8 @@ public class XmlWriterException { /** - * @param message The message for the exception. - * @param e The exception itself. + * @param message the message for the exception + * @param e the exception itself */ public XmlWriterException( String message, Exception e ) { diff --git a/api/maven-api-model/src/main/mdo/maven.mdo b/api/maven-api-model/src/main/mdo/maven.mdo index 8e6f14665cc7..0b18badad166 100644 --- a/api/maven-api-model/src/main/mdo/maven.mdo +++ b/api/maven-api-model/src/main/mdo/maven.mdo @@ -2304,7 +2304,7 @@ /** * Gets the identifier of the plugin. * - * @return The plugin id in the form {@code ::}, never {@code null}. + * @return the plugin id in the form {@code ::}, never {@code null} */ public String getId() {