Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[MNG-7582] Reformat apiv4 javadoc according to usual rules 

Fixes  #853
This commit is contained in:
Guillaume Nodet 2022-10-26 22:42:39 +02:00 committed by GitHub
parent 79b6dd0bab
commit cb424b93e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
35 changed files with 128 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
api/maven-api-core/src/main/java/org/apache/maven/api/Artifact.java
View File

@ -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 @@ public interface Artifact
/**
* The groupId of the artifact.
*
* @return The groupId.
* @return the groupId
*/
@Nonnull
String getGroupId();
@ -58,7 +59,7 @@ public interface Artifact
/**
* The artifactId of the artifact.
*
* @return The artifactId.
* @return the artifactId
*/
@Nonnull
String getArtifactId();
@ -66,7 +67,7 @@ public interface Artifact
/**
* The version of the artifact.
*
* @return The version.
* @return the version
*/
@Nonnull
Version getVersion();
@ -74,7 +75,7 @@ public interface Artifact
/**
* 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 @@ public interface Artifact
/**
* The file extension of the artifact.
*
* @return The extension.
* @return the extension
*/
@Nonnull
String getExtension();
@ -90,7 +91,7 @@ public interface Artifact
/**
* 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();

10
api/maven-api-core/src/main/java/org/apache/maven/api/ArtifactCoordinate.java
View File

@ -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();

3
api/maven-api-core/src/main/java/org/apache/maven/api/Dependency.java
View File

@ -27,11 +27,12 @@ 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();
@Nonnull
Scope getScope();
boolean isOptional();

2
api/maven-api-core/src/main/java/org/apache/maven/api/DependencyCoordinate.java
View File

@ -37,7 +37,7 @@ public interface DependencyCoordinate extends ArtifactCoordinate
/**
* The type of the artifact.
*
* @return The type.
* @return the type
*/
@Nonnull
Type getType();

10
api/maven-api-core/src/main/java/org/apache/maven/api/Event.java
View File

@ -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<Project> 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<MojoExecution> 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<Exception> getException();

4
api/maven-api-core/src/main/java/org/apache/maven/api/Node.java
View File

@ -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 );

4
api/maven-api-core/src/main/java/org/apache/maven/api/Repository.java
View File

@ -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();

14
api/maven-api-core/src/main/java/org/apache/maven/api/Session.java
View File

@ -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<String, String> 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<String, String> getSystemProperties();
/**
* Returns the current maven version
* @return the maven version, never {@code null}.
* @return the maven version, never {@code null}
*/
@Nonnull
String getMavenVersion();

20
api/maven-api-core/src/main/java/org/apache/maven/api/SessionData.java
View File

@ -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<Object> supplier );

2
api/maven-api-core/src/main/java/org/apache/maven/api/Toolchain.java
View File

@ -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 );

4
api/maven-api-core/src/main/java/org/apache/maven/api/VersionRange.java
View File

@ -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 );

2
api/maven-api-core/src/main/java/org/apache/maven/api/plugin/Mojo.java
View File

@ -39,7 +39,7 @@ public interface Mojo
* This is the main trigger for the <code>Mojo</code> inside the <code>Maven</code> system, and allows
* the <code>Mojo</code> to communicate errors.
*
* @throws MojoException if a problem occurs.
* @throws MojoException if a problem occurs
*/
void execute();

12
api/maven-api-core/src/main/java/org/apache/maven/api/plugin/MojoException.java
View File

@ -37,7 +37,7 @@ public class MojoException
protected String longMessage;
/**
* Construct a new <code>MojoExecutionException</code> exception providing the source and a short and long message:
* Construct a new <code>MojoException</code> 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 )
@ -47,15 +47,6 @@ public class MojoException
this.longMessage = longMessage;
}
/**
* Construct a new <code>MojoExecutionException</code> exception wrapping an underlying <code>Exception</code>
* and providing a <code>message</code>.
*/
public MojoException( String message, Exception cause )
{
super( message, cause );
}
/**
* Construct a new <code>MojoExecutionException</code> exception wrapping an underlying <code>Throwable</code>
* and providing a <code>message</code>.
@ -78,7 +69,6 @@ public class MojoException
*
* @param cause the cause which is saved for later retrieval by the {@link #getCause()} method.
* A {@code null} value is permitted, and indicates that the cause is nonexistent or unknown.
* @since 3.8.3
*/
public MojoException( Throwable cause )
{

2
api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactDeployerException.java
View File

@ -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 )

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstaller.java
View File

@ -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 );

2
api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstallerException.java
View File

@ -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 )

6
api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactResolver.java
View File

@ -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<? extends ArtifactCoordinate> coordinates )

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactResolverException.java
View File

@ -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 )
{

30
api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollector.java
View File

@ -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 @@ 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 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 @@ 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 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)
*/

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollectorException.java
View File

@ -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 )
{

24
api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollectorRequest.java
View File

@ -134,8 +134,8 @@ public interface DependencyCollectorRequest
* 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 interface DependencyCollectorRequest
/**
* @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 interface DependencyCollectorRequest
* 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<DependencyCoordinate> dependencies )
@ -173,8 +173,8 @@ public interface DependencyCollectorRequest
/**
* Adds the specified direct dependency.
*
* @param dependency The dependency to add, may be {@code null}.
* @return This request for chaining, never {@code null}.
* @param dependency the dependency to add, may be {@code null}
* @return this request for chaining, never {@code null}
*/
@Nonnull
public DependencyCollectorRequestBuilder dependency( @Nullable DependencyCoordinate dependency )
@ -196,8 +196,8 @@ public interface DependencyCollectorRequest
* apply to
* the direct dependencies of the root node.
*
* @param managedDependencies The dependency management, may be {@code null}.
* @return This request for chaining, never {@code null}.
* @param managedDependencies the dependency management, may be {@code null}
* @return this request for chaining, never {@code null}
*/
@Nonnull
public DependencyCollectorRequestBuilder managedDependencies(
@ -212,7 +212,7 @@ public interface DependencyCollectorRequest
*
* @param managedDependency The managed dependency to add, may be {@code null} in which case the call
* will have no effect.
* @return This request for chaining, never {@code null}.
* @return this request for chaining, never {@code null}
*/
@Nonnull
public DependencyCollectorRequestBuilder managedDependency( @Nullable DependencyCoordinate managedDependency )
@ -231,8 +231,8 @@ public interface DependencyCollectorRequest
/**
* Specifies that the collection should be verbose.
*
* @param verbose whether the collection should be verbose or not.
* @return This request for chaining, never {@code null}.
* @param verbose whether the collection should be verbose or not
* @return this request for chaining, never {@code null}
*/
@Nonnull
public DependencyCollectorRequestBuilder verbose( boolean verbose )

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCollectorResult.java
View File

@ -36,14 +36,14 @@ public interface DependencyCollectorResult
/**
* Gets the exceptions that occurred while building the dependency graph.
*
* @return The exceptions that occurred, never {@code null}.
* @return the exceptions that occurred, never {@code null}
*/
List<Exception> 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();

2
api/maven-api-core/src/main/java/org/apache/maven/api/services/DependencyCoordinateFactory.java
View File

@ -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

6
api/maven-api-core/src/main/java/org/apache/maven/api/services/LookupException.java
View File

@ -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 class LookupException
}
/**
* @param e The {@link Exception}.
* @param e the {@link Exception}
*/
public LookupException( Exception e )
{

2
api/maven-api-core/src/main/java/org/apache/maven/api/services/MessageBuilder.java
View File

@ -141,7 +141,7 @@ public interface MessageBuilder
* Append formatted content to the buffer.
* @see String#format(String, Object...)
* @param pattern a <a href="../util/Formatter.html#syntax">format string</a>
* @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

16
api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilder.java
View File

@ -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 @@ 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 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 @@ public interface ProjectBuilder extends Service
/**
* 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 @@ public interface ProjectBuilder extends Service
/**
* 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)

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderException.java
View File

@ -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 )
{

8
api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderResult.java
View File

@ -42,7 +42,7 @@ public interface ProjectBuilderResult
* <groupId>:<artifactId>:<version>} 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<Path> 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<ProjectBuilderProblem> 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<DependencyCollectorResult> getDependencyResolverResult();

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/PrompterException.java
View File

@ -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 )
{

12
api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionParser.java
View File

@ -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 );

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/VersionParserException.java
View File

@ -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 )
{

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderException.java
View File

@ -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 )
{

2
api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderRequest.java
View File

@ -65,7 +65,7 @@ public interface XmlReaderRequest
* @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 );
}

4
api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlWriterException.java
View File

@ -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 )
{

2
api/maven-api-model/src/main/mdo/maven.mdo
View File

@ -2304,7 +2304,7 @@
/**
* Gets the identifier of the plugin.
*
* @return The plugin id in the form {@code <groupId>:<artifactId>:<version>}, never {@code null}.
* @return the plugin id in the form {@code <groupId>:<artifactId>:<version>}, never {@code null}
*/
public String getId()
{