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

fix javadoc errors

This commit is contained in:
Hervé Boutemy 2021-10-17 12:07:50 +02:00
parent 2f81b7d93b
commit f46a9131d5
24 changed files with 121 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
maven-artifact/src/main/java/org/apache/maven/artifact/ArtifactUtils.java
View File

@ -173,7 +173,14 @@ public final class ArtifactUtils
return clone;
}
/** Returns <code>to</code> collection */
/**
* Copy artifact to a collection.
*
* @param <T> the target collection type
* @param from an artifact collection
* @param to the target artifact collection
* @return <code>to</code> collection
*/
public static <T extends Collection<Artifact>> T copyArtifacts( Collection<Artifact> from, T to )
{
for ( Artifact artifact : from )

19
maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepository.java
View File

@ -73,10 +73,16 @@ public interface ArtifactRepository
@Deprecated
void setBlacklisted( boolean blackListed );
/** @since 3.8.1 **/
/**
* @return whether the repository is blocked
* @since 3.8.1
**/
boolean isBlocked();
/** @since 3.8.1 **/
/**
* @param blocked block the repository?
* @since 3.8.1
**/
void setBlocked( boolean blocked );
//
@ -84,7 +90,8 @@ public interface ArtifactRepository
//
/**
*
* @param artifact
* @param artifact an artifact
* @return found artifact
* @since 3.0-alpha-3
*/
Artifact find( Artifact artifact );
@ -108,20 +115,26 @@ public interface ArtifactRepository
boolean isProjectAware();
/**
* @param authentication authentication
* @since 3.0-alpha-3
*/
void setAuthentication( Authentication authentication );
/**
* @return repository authentication
* @since 3.0-alpha-3
*/
Authentication getAuthentication();
/**
* @param proxy proxy
* @since 3.0-alpha-3
*/
void setProxy( Proxy proxy );
/**
* @since 3.0-alpha-3
* @return repository proxy
*/
Proxy getProxy();

7
maven-artifact/src/main/java/org/apache/maven/artifact/resolver/MultipleArtifactsNotFoundException.java
View File

@ -37,7 +37,12 @@ public class MultipleArtifactsNotFoundException
private final List<Artifact> resolvedArtifacts;
private final List<Artifact> missingArtifacts;
/** @deprecated use {@link #MultipleArtifactsNotFoundException(Artifact, List, List, List)} */
/**
* @param originatingArtifact the artifact that was being resolved
* @param missingArtifacts artifacts that could not be resolved
* @param remoteRepositories remote repositories where the missing artifacts were not found
* @deprecated use {@link #MultipleArtifactsNotFoundException(Artifact, List, List, List)}
*/
@Deprecated
public MultipleArtifactsNotFoundException( Artifact originatingArtifact,
List<Artifact> missingArtifacts,

3
maven-artifact/src/main/java/org/apache/maven/artifact/versioning/VersionRange.java
View File

@ -101,8 +101,7 @@ public class VersionRange
*
* @param spec string representation of a version or version range
* @return a new {@link VersionRange} object that represents the spec
* @throws InvalidVersionSpecificationException
*
* @throws InvalidVersionSpecificationException if invalid version specification
*/
public static VersionRange createFromVersionSpec( String spec )
throws InvalidVersionSpecificationException

13
maven-artifact/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadata.java
View File

@ -31,10 +31,18 @@ import org.apache.maven.artifact.repository.metadata.RepositoryMetadataStoreExce
*/
public interface ArtifactMetadata
{
/** Whether this metadata should be stored alongside the artifact. */
/**
* Whether this metadata should be stored alongside the artifact.
*
* @return whether this metadata should be stored alongside the artifact
*/
boolean storedInArtifactVersionDirectory();
/** Whether this metadata should be stored alongside the group. */
/**
* Whether this metadata should be stored alongside the group.
*
* @return whether this metadata should be stored alongside the group
*/
boolean storedInGroupDirectory();
String getGroupId();
@ -73,6 +81,7 @@ public interface ArtifactMetadata
*
* @param localRepository the local repository
* @param remoteRepository the remote repository it came from
* @throws RepositoryMetadataStoreException in case of issue
* TODO this should only be needed on the repository metadata
*/
void storeInLocalRepository( ArtifactRepository localRepository,

2
maven-builder-support/src/main/java/org/apache/maven/building/ProblemCollector.java
View File

@ -46,7 +46,7 @@ public interface ProblemCollector
* The next messages will be bound to this source. When calling this method again, previous messages keep
* their source, but the next messages will use the new source.
*
* @param source
* @param source a source
*/
void setSource( String source );

1
maven-builder-support/src/main/java/org/apache/maven/building/Source.java
View File

@ -34,6 +34,7 @@ public interface Source
* Gets a byte stream to the source contents. Closing the returned stream is the responsibility of the caller.
*
* @return A byte stream to the source contents, never {@code null}.
* @throws IOException in case of IO issue
*/
InputStream getInputStream()
throws IOException;

5
maven-compat/src/main/java/org/apache/maven/artifact/ArtifactScopeEnum.java
View File

@ -49,6 +49,9 @@ public enum ArtifactScopeEnum
/**
* Helper method to simplify null processing
*
* @param scope a scope or {@code null}
* @return the provided scope or DEFAULT_SCOPE
*/
public static ArtifactScopeEnum checkScope( ArtifactScopeEnum scope )
{
@ -99,7 +102,7 @@ public enum ArtifactScopeEnum
/**
* scope relationship function. Used by the graph conflict resolution policies
*
* @param scope
* @param scope a scope
* @return true is supplied scope is an inclusive sub-scope of current one.
*/
public boolean encloses( ArtifactScopeEnum scope )

3
maven-compat/src/main/java/org/apache/maven/artifact/manager/WagonManager.java
View File

@ -40,6 +40,9 @@ public interface WagonManager
/**
* this method is only here for backward compat (project-info-reports:dependencies)
* the default implementation will return an empty AuthenticationInfo
*
* @param id an id
* @return corresponding authentication info
*/
AuthenticationInfo getAuthenticationInfo( String id );

2
maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/DefaultRepositoryMetadataManager.java
View File

@ -311,7 +311,7 @@ public class DefaultRepositoryMetadataManager
return setRepository;
}
/**
/*
* TODO share with DefaultPluginMappingManager.
*/
protected Metadata readMetadata( File mappingFile )

9
maven-core/src/main/java/org/apache/maven/AbstractMavenLifecycleParticipant.java
View File

@ -39,6 +39,9 @@ public abstract class AbstractMavenLifecycleParticipant
*
* This callback is intended to allow extensions to manipulate MavenProjects
* before they are sorted and actual build execution starts.
*
* @param session the Maven session
* @throws MavenExecutionException in case of issue
*/
public void afterProjectsRead( MavenSession session )
throws MavenExecutionException
@ -52,6 +55,9 @@ public abstract class AbstractMavenLifecycleParticipant
* This callback is intended to allow extensions to inject execution properties,
* activate profiles and perform similar tasks that affect MavenProject
* instance construction.
*
* @param session the Maven session
* @throws MavenExecutionException in case of issue
*/
// TODO This is too early for build extensions, so maybe just remove it?
public void afterSessionStart( MavenSession session )
@ -67,6 +73,9 @@ public abstract class AbstractMavenLifecycleParticipant
* allocated external resources after the build. It is invoked on best-effort
* basis and may be missed due to an Error or RuntimeException in Maven core
* code.
*
* @param session the Maven session
* @throws MavenExecutionException in case of issue
* @since 3.2.1, MNG-5389
*/
public void afterSessionEnd( MavenSession session )

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

@ -31,6 +31,7 @@ public interface ArtifactFilterManager
/**
* Returns a filter for core + extension artifacts.
*
* @return the artifact filter
* @deprecated use {@code META-INF/maven/extension.xml} to define artifacts exported by Maven core and plugin
* extensions.
*/
@ -38,12 +39,15 @@ public interface ArtifactFilterManager
/**
* Returns a filter for only the core artifacts.
*
* @return the artifact filter
*/
ArtifactFilter getCoreArtifactFilter();
/**
* Exclude an extension artifact (doesn't affect getArtifactFilter's result, only getExtensionArtifactFilter).
*
* @param artifactId an artifact id
* @deprecated use {@code META-INF/maven/extension.xml} to define artifacts exported by Maven core and plugin
* extensions.
*/

8
maven-core/src/main/java/org/apache/maven/ProjectDependenciesResolver.java
View File

@ -45,6 +45,8 @@ public interface ProjectDependenciesResolver
* @param scopesToResolve The dependency scopes that should be resolved, may be {@code null}.
* @param session The current build session, must not be {@code null}.
* @return The transitive dependencies of the specified project that match the requested scopes, never {@code null}.
* @throws ArtifactResolutionException in case of resolution issue
* @throws ArtifactNotFoundException if an artifact is not found
*/
Set<Artifact> resolve( MavenProject project, Collection<String> scopesToResolve, MavenSession session )
throws ArtifactResolutionException, ArtifactNotFoundException;
@ -57,6 +59,8 @@ public interface ProjectDependenciesResolver
* @param scopesToResolve The dependency scopes that should be collected and also resolved, may be {@code null}.
* @param session The current build session, must not be {@code null}.
* @return The transitive dependencies of the specified project that match the requested scopes, never {@code null}.
* @throws ArtifactResolutionException in case of resolution issue
* @throws ArtifactNotFoundException if an artifact is not found
*/
Set<Artifact> resolve( MavenProject project, Collection<String> scopesToCollect,
Collection<String> scopesToResolve, MavenSession session )
@ -71,6 +75,8 @@ public interface ProjectDependenciesResolver
* @param session The current build session, must not be {@code null}.
* @param ignoreableArtifacts Artifacts that need not be resolved
* @return The transitive dependencies of the specified project that match the requested scopes, never {@code null}.
* @throws ArtifactResolutionException in case of resolution issue
* @throws ArtifactNotFoundException if an artifact is not found
*/
Set<Artifact> resolve( MavenProject project, Collection<String> scopesToCollect,
Collection<String> scopesToResolve, MavenSession session, Set<Artifact> ignoreableArtifacts )
@ -87,6 +93,8 @@ public interface ProjectDependenciesResolver
* @param session The current build session, must not be {@code null}.
* @return The transitive dependencies of the specified projects that match the requested scopes, never
* {@code null}.
* @throws ArtifactResolutionException in case of resolution issue
* @throws ArtifactNotFoundException if an artifact is not found
*/
Set<Artifact> resolve( Collection<? extends MavenProject> projects, Collection<String> scopes,
MavenSession session )

16
maven-core/src/main/java/org/apache/maven/artifact/metadata/ArtifactMetadataRetrievalException.java
View File

@ -29,21 +29,31 @@ public class ArtifactMetadataRetrievalException
extends org.apache.maven.repository.legacy.metadata.ArtifactMetadataRetrievalException
{
/** @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)} */
/**
* @param message a message
* @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)}
*/
@Deprecated
public ArtifactMetadataRetrievalException( String message )
{
super( message, null, null );
}
/** @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)} */
/**
* @param cause a cause
* @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)}
*/
@Deprecated
public ArtifactMetadataRetrievalException( Throwable cause )
{
super( null, cause, null );
}
/** @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)} */
/**
* @param message a message
* @param cause a cause
* @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)}
*/
@Deprecated
public ArtifactMetadataRetrievalException( String message,
Throwable cause )

2
maven-core/src/main/java/org/apache/maven/artifact/repository/metadata/RepositoryMetadataManager.java
View File

@ -48,6 +48,7 @@ public interface RepositoryMetadataManager
* @param metadata the metadata to deploy
* @param localRepository the local repository to install to first
* @param deploymentRepository the remote repository to deploy to
* @throws RepositoryMetadataDeploymentException in case of metadata deployment issue
*/
void deploy( ArtifactMetadata metadata, ArtifactRepository localRepository,
ArtifactRepository deploymentRepository )
@ -58,6 +59,7 @@ public interface RepositoryMetadataManager
*
* @param metadata the metadata
* @param localRepository the local repository
* @throws RepositoryMetadataInstallationException in case of metadata installation issue
*/
void install( ArtifactMetadata metadata, ArtifactRepository localRepository )
throws RepositoryMetadataInstallationException;

3
maven-core/src/main/java/org/apache/maven/artifact/resolver/ArtifactResolutionResult.java
View File

@ -189,6 +189,9 @@ public class ArtifactResolutionResult
* TODO this needs to accept a {@link OverConstrainedVersionException} as returned by
* {@link #getVersionRangeViolation(int)} but it's not used like that in
* DefaultLegacyArtifactCollector
*
* @param e an exception
* @return {@code this}
*/
public ArtifactResolutionResult addVersionRangeViolation( Exception e )
{

4
maven-core/src/main/java/org/apache/maven/artifact/resolver/ResolutionNode.java
View File

@ -113,7 +113,7 @@ public class ResolutionNode
/**
* @return {@link List} &lt; {@link String} &gt; with artifact ids
* @throws OverConstrainedVersionException
* @throws OverConstrainedVersionException if version specification is over constrained
*/
public List<String> getDependencyTrail()
throws OverConstrainedVersionException
@ -172,6 +172,8 @@ public class ResolutionNode
/**
* Test whether the node is direct or transitive dependency.
*
* @return whether the node is direct or transitive dependency
*/
public boolean isChildOfRootNode()
{

4
maven-core/src/main/java/org/apache/maven/bridge/MavenRepositorySystem.java
View File

@ -614,8 +614,8 @@ public class MavenRepositorySystem
/**
* Source from org.apache.maven.repository.legacy.LegacyRepositorySystem#getEffectiveRepositories
*
* @param repositories
* @return
* @param repositories a list of repositories
* @return corresponding effective repositories
* @since 3.6.1
*/
public List<ArtifactRepository> getEffectiveRepositories( List<ArtifactRepository> repositories )

1
maven-core/src/main/java/org/apache/maven/classrealm/ClassRealmRequest.java
View File

@ -72,6 +72,7 @@ public interface ClassRealmRequest
/**
* @deprecated Use {@link #getParentImports()} instead.
* @return imports
*/
@Deprecated
List<String> getImports();

16
maven-core/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadataRetrievalException.java
View File

@ -31,21 +31,31 @@ public class ArtifactMetadataRetrievalException
{
private Artifact artifact;
/** @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)} */
/**
* @param message a message
* @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)}
*/
@Deprecated
public ArtifactMetadataRetrievalException( String message )
{
this( message, null, null );
}
/** @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)} */
/**
* @param cause a cause
* @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)}
*/
@Deprecated
public ArtifactMetadataRetrievalException( Throwable cause )
{
this( null, cause, null );
}
/** @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)} */
/**
* @param message a message
* @param cause a cause
* @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)}
*/
@Deprecated
public ArtifactMetadataRetrievalException( String message,
Throwable cause )

6
maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java
View File

@ -217,6 +217,12 @@ public class MavenCli
* This supports painless invocation by the Verifier during embedded execution of the core ITs.
* See <a href="http://maven.apache.org/shared/maven-verifier/xref/org/apache/maven/it/Embedded3xLauncher.html">
* <code>Embedded3xLauncher</code> in <code>maven-verifier</code></a>
*
* @param args CLI args
* @param workingDirectory working directory
* @param stdout stdout
* @param stderr stderr
* @return return code
*/
public int doMain( String[] args, String workingDirectory, PrintStream stdout, PrintStream stderr )
{

6
maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java
View File

@ -167,7 +167,7 @@ public class DefaultModelBuilder
/**
* @deprecated since Maven 4
* @see DefaultModelBuilderFactory#set
* @see DefaultModelBuilderFactory#setModelProcessor(ModelProcessor)
*/
@Deprecated
public DefaultModelBuilder setModelProcessor( ModelProcessor modelProcessor )
@ -223,7 +223,7 @@ public class DefaultModelBuilder
/**
* @deprecated since Maven 4
* @see DefaultModelBuilderFactory#set
* @see DefaultModelBuilderFactory#setModelPathTranslator(ModelPathTranslator)
*/
@Deprecated
public DefaultModelBuilder setModelPathTranslator( ModelPathTranslator modelPathTranslator )
@ -279,7 +279,7 @@ public class DefaultModelBuilder
/**
* @deprecated since Maven 4
* @see DefaultModelBuilderFactory#set
* @see DefaultModelBuilderFactory#setProfileSelector(ProfileSelector)
*/
@Deprecated
public DefaultModelBuilder setProfileSelector( ProfileSelector profileSelector )

2
maven-model-builder/src/main/java/org/apache/maven/model/building/Result.java
View File

@ -39,7 +39,7 @@ import java.util.List;
* Could encode these variants as subclasses, but kept in one for now
*
* @author bbusjaeger
* @param <T>
* @param <T> the model type
*/
public class Result<T>
{

2
maven-model/src/main/java/org/apache/maven/model/merge/ModelMerger.java
View File

@ -2640,7 +2640,7 @@ public class ModelMerger
/**
* Use to compute keys for data structures
* @param <T>
* @param <T> the data structure type
*/
@FunctionalInterface
public interface KeyComputer<T> extends Function<T, Object>