You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kh...@apache.org on 2017/09/09 10:36:01 UTC
svn commit: r1807877 [1/4] - in
/maven/plugins/trunk/maven-dependency-plugin/src:
main/java/org/apache/maven/plugins/dependency/
main/java/org/apache/maven/plugins/dependency/analyze/
main/java/org/apache/maven/plugins/dependency/fromConfiguration/ mai...
Author: khmarbaise
Date: Sat Sep 9 10:35:59 2017
New Revision: 1807877
URL: http://svn.apache.org/viewvc?rev=1807877&view=rev
Log:
[MDEP-583] Failed to create release on JDK 8 based on JavaDoc issues
o Fixed JavaDoc issues with JDK 8.
o Fixed some checkstyle reported issues as well.
Modified:
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/AbstractDependencyMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/DisplayAncestorsMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/GetMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/PropertiesMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AbstractAnalyzeMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDepMgt.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDuplicateMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeOnlyMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportView.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ProcessArtifactItemsRequest.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractFromDependenciesMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/BuildClasspathMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/CopyDependenciesMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/UnpackDependenciesMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/resolvers/AbstractResolveMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/resolvers/CollectDependenciesMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/resolvers/GoOfflineMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/resolvers/ListRepositoriesMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependenciesMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependencySourcesMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolvePluginsMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/tree/AbstractSerializingVisitor.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/tree/DOTDependencyNodeVisitor.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/tree/GraphmlDependencyNodeVisitor.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/tree/TGFDependencyNodeVisitor.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/utils/DependencySilentLog.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyStatusSets.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyUtil.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/utils/filters/DestFileFilter.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/utils/filters/MarkerFileFilter.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/utils/markers/DefaultFileMarkerHandler.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/utils/markers/SourcesFileMarkerHandler.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/utils/markers/UnpackFileMarkerHandler.java
maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/utils/translators/ClassifierTypeTranslator.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/AbstractDependencyMojoTestCase.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/TestCollectMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/TestGetMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/TestPropertiesMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/TestSkip.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/analyze/TestAnalyzeDepMgt.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/analyze/TestAnalyzeDuplicateMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromConfiguration/TestCopyMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromConfiguration/TestIncludeExcludeUnpackMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromConfiguration/TestUnpackMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromDependencies/TestBuildClasspathMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromDependencies/TestCopyDependenciesMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromDependencies/TestCopyDependenciesMojo2.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromDependencies/TestIncludeExcludeUnpackDependenciesMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromDependencies/TestUnpackDependenciesMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromDependencies/TestUnpackDependenciesMojo2.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependenciesMojoTest.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/resolvers/TestResolveMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/testUtils/DependencyArtifactStubFactory.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/testUtils/DependencyTestUtils.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/testUtils/stubs/DependencyProjectStub.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/testUtils/stubs/DuplicateDependencies2ProjectStub.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/testUtils/stubs/DuplicateDependenciesProjectStub.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/testUtils/stubs/StubUnpackFileMarkerHandler.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/tree/TestTreeMojo.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/utils/TestDependencyStatusSets.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/utils/TestDependencyUtil.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/utils/filters/TestDestFileFilter.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/utils/filters/TestMarkerFileFilter.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/utils/filters/TestResolveMarkerFileFilter.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/utils/markers/TestDefaultMarkerFileHandler.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/utils/markers/TestSourcesMarkerFileHandler.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/utils/markers/TestUnpackMarkerFileHandler.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/utils/translators/TestClassifierTypeTranslator.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/codehaus/plexus/util/interpolation/Interpolator.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/codehaus/plexus/util/interpolation/RegexBasedInterpolator.java
maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/codehaus/plexus/util/interpolation/ValueSource.java
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/AbstractDependencyMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/AbstractDependencyMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/AbstractDependencyMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/AbstractDependencyMojo.java Sat Sep 9 10:35:59 2017
@@ -48,8 +48,7 @@ import org.codehaus.plexus.util.StringUt
/**
* @author <a href="mailto:brianf@apache.org">Brian Fox</a>
- * @version $Id: AbstractDependencyMojo.java 552528
- * 2007-07-02 16:12:47Z markh $
+ * @version $Id$
*/
public abstract class AbstractDependencyMojo
extends AbstractMojo
@@ -65,6 +64,7 @@ public abstract class AbstractDependency
* will use the jvm chmod, this is available for user and all level group level will be ignored
* </p>
* <b>since 2.6 is on by default</b>
+ *
* @since 2.5.1
*/
@Parameter( property = "dependency.useJvmChmod", defaultValue = "true" )
@@ -72,6 +72,7 @@ public abstract class AbstractDependency
/**
* ignore to set file permissions when unpacking a dependency
+ *
* @since 2.7
*/
@Parameter( property = "dependency.ignorePermissions", defaultValue = "false" )
@@ -82,7 +83,7 @@ public abstract class AbstractDependency
*/
@Parameter( defaultValue = "${project}", readonly = true, required = true )
private MavenProject project;
-
+
/**
* Remote repositories which will be searched for artifacts.
*/
@@ -100,7 +101,7 @@ public abstract class AbstractDependency
*/
@Parameter( defaultValue = "${session}", readonly = true, required = true )
protected MavenSession session;
-
+
/**
* If the plugin should be silent.
*
@@ -144,7 +145,7 @@ public abstract class AbstractDependency
}
protected abstract void doExecute()
- throws MojoExecutionException, MojoFailureException;
+ throws MojoExecutionException, MojoFailureException;
/**
* @return Returns the archiverManager.
@@ -159,8 +160,7 @@ public abstract class AbstractDependency
*
* @param artifact represents the file to copy.
* @param destFile file name of destination file.
- * @throws MojoExecutionException with a message if an
- * error occurs.
+ * @throws MojoExecutionException with a message if an error occurs.
*/
protected void copyFile( File artifact, File destFile )
throws MojoExecutionException
@@ -168,8 +168,8 @@ public abstract class AbstractDependency
try
{
getLog().info( "Copying "
- + ( this.outputAbsoluteArtifactFilename ? artifact.getAbsolutePath()
- : artifact.getName() ) + " to " + destFile );
+ + ( this.outputAbsoluteArtifactFilename ? artifact.getAbsolutePath() : artifact.getName() ) + " to "
+ + destFile );
if ( artifact.isDirectory() )
{
@@ -202,6 +202,7 @@ public abstract class AbstractDependency
* @param excludes Comma separated list of file patterns to exclude i.e. <code>**/*.xml,
* **/*.properties</code>
* @param encoding Encoding of artifact. Set {@code null} for default encoding.
+ * @throws MojoExecutionException In case of errors.
*/
protected void unpack( Artifact artifact, File location, String includes, String excludes, String encoding )
throws MojoExecutionException
@@ -213,7 +214,7 @@ public abstract class AbstractDependency
String encoding )
throws MojoExecutionException
{
- File file = artifact.getFile();
+ File file = artifact.getFile();
try
{
logUnpack( file, location, includes, excludes );
@@ -221,8 +222,8 @@ public abstract class AbstractDependency
location.mkdirs();
if ( !location.exists() )
{
- throw new MojoExecutionException(
- "Location to write unpacked files to could not be created: " + location );
+ throw new MojoExecutionException( "Location to write unpacked files to could not be created: "
+ + location );
}
if ( file.isDirectory() )
@@ -265,7 +266,7 @@ public abstract class AbstractDependency
// based on include/exclude parameters
// MDEP-47
IncludeExcludeFileSelector[] selectors =
- new IncludeExcludeFileSelector[]{ new IncludeExcludeFileSelector() };
+ new IncludeExcludeFileSelector[] { new IncludeExcludeFileSelector() };
if ( StringUtils.isNotEmpty( excludes ) )
{
@@ -292,8 +293,8 @@ public abstract class AbstractDependency
}
catch ( ArchiverException e )
{
- throw new MojoExecutionException(
- "Error unpacking file: " + file + " to: " + location + "\r\n" + e.toString(), e );
+ throw new MojoExecutionException( "Error unpacking file: " + file + " to: " + location + "\r\n"
+ + e.toString(), e );
}
}
@@ -363,18 +364,18 @@ public abstract class AbstractDependency
{
this.skip = skip;
}
-
+
protected final boolean isSilent()
{
return silent;
}
-
+
public void setSilent( boolean silent )
{
this.silent = silent;
if ( silent )
{
- setLog( new DependencySilentLog() );
+ setLog( new DependencySilentLog() );
}
}
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/DisplayAncestorsMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/DisplayAncestorsMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/DisplayAncestorsMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/DisplayAncestorsMojo.java Sat Sep 9 10:35:59 2017
@@ -33,8 +33,8 @@ import java.util.List;
import java.util.Locale;
/**
- * Displays all ancestor POMs of the project. This may be useful in a continuous integration system
- * where you want to know all parent poms of the project.
+ * Displays all ancestor POMs of the project. This may be useful in a continuous integration system where you want to
+ * know all parent poms of the project.
*
* @author Mirko Friedenhagen
* @since 2.9
@@ -74,8 +74,8 @@ public class DisplayAncestorsMojo
MavenProject currentAncestor = project.getParent();
while ( currentAncestor != null )
{
- final String gav = String.format( Locale.US, "%s:%s:%s",
- currentAncestor.getGroupId(), currentAncestor.getArtifactId(), currentAncestor.getVersion() );
+ final String gav = String.format( Locale.US, "%s:%s:%s", currentAncestor.getGroupId(),
+ currentAncestor.getArtifactId(), currentAncestor.getVersion() );
ancestors.add( gav );
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/GetMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/GetMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/GetMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/GetMojo.java Sat Sep 9 10:35:59 2017
@@ -52,19 +52,18 @@ import org.apache.maven.shared.dependenc
import org.codehaus.plexus.util.StringUtils;
/**
- * Resolves a single artifact, eventually transitively, from the specified remote repositories.
- * Caveat: will always check the central repository defined in the super pom. You could use a mirror entry in your
- * <code>settings.xml</code>
+ * Resolves a single artifact, eventually transitively, from the specified remote repositories. Caveat: will always
+ * check the central repository defined in the super pom. You could use a mirror entry in your <code>settings.xml</code>
*/
@Mojo( name = "get", requiresProject = false, threadSafe = true )
public class GetMojo
extends AbstractMojo
{
private static final Pattern ALT_REPO_SYNTAX_PATTERN = Pattern.compile( "(.+)::(.*)::(.+)" );
-
+
@Parameter( defaultValue = "${session}", required = true, readonly = true )
private MavenSession session;
-
+
/**
*
*/
@@ -74,11 +73,11 @@ public class GetMojo
/**
*
*/
- @Component
- private DependencyResolver dependencyResolver;
+ @Component
+ private DependencyResolver dependencyResolver;
- @Component
- private ArtifactHandlerManager artifactHandlerManager;
+ @Component
+ private ArtifactHandlerManager artifactHandlerManager;
/**
* Map that contains the layouts.
@@ -87,7 +86,7 @@ public class GetMojo
private Map<String, ArtifactRepositoryLayout> repositoryLayouts;
private DefaultDependableCoordinate coordinate = new DefaultDependableCoordinate();
-
+
/**
* The groupId of the artifact to download. Ignored if {@link #artifact} is used.
*/
@@ -121,8 +120,8 @@ public class GetMojo
private String packaging = "jar";
/**
- * Repositories in the format id::[layout]::url or just url, separated by comma.
- * ie. central::default::http://repo1.maven.apache.org/maven2,myrepo::::http://repo.acme.com,http://repo.acme2.com
+ * Repositories in the format id::[layout]::url or just url, separated by comma. ie.
+ * central::default::http://repo1.maven.apache.org/maven2,myrepo::::http://repo.acme.com,http://repo.acme2.com
*/
@Parameter( property = "remoteRepositories" )
private String remoteRepositories;
@@ -173,9 +172,8 @@ public class GetMojo
String[] tokens = StringUtils.split( artifact, ":" );
if ( tokens.length < 3 || tokens.length > 5 )
{
- throw new MojoFailureException(
- "Invalid artifact, you must specify groupId:artifactId:version[:packaging[:classifier]] "
- + artifact );
+ throw new MojoFailureException( "Invalid artifact, you must specify "
+ + "groupId:artifactId:version[:packaging[:classifier]] " + artifact );
}
coordinate.setGroupId( tokens[0] );
coordinate.setArtifactId( tokens[1] );
@@ -215,7 +213,7 @@ public class GetMojo
{
ProjectBuildingRequest buildingRequest =
new DefaultProjectBuildingRequest( session.getProjectBuildingRequest() );
-
+
buildingRequest.setRemoteRepositories( repoList );
if ( transitive )
@@ -300,31 +298,31 @@ public class GetMojo
// @Parameter( alias = "groupId" )
public void setGroupId( String groupId )
{
- this.coordinate.setGroupId( groupId );
+ this.coordinate.setGroupId( groupId );
}
-
+
// @Parameter( alias = "artifactId" )
public void setArtifactId( String artifactId )
{
- this.coordinate.setArtifactId( artifactId );
+ this.coordinate.setArtifactId( artifactId );
}
-
+
// @Parameter( alias = "version" )
public void setVersion( String version )
{
- this.coordinate.setVersion( version );
+ this.coordinate.setVersion( version );
}
-
+
// @Parameter( alias = "classifier" )
public void setClassifier( String classifier )
{
- this.coordinate.setClassifier( classifier );
+ this.coordinate.setClassifier( classifier );
}
-
+
// @Parameter( alias = "packaging" )
public void setPackaging( String type )
{
- this.coordinate.setType( type );
+ this.coordinate.setType( type );
}
}
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/PropertiesMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/PropertiesMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/PropertiesMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/PropertiesMojo.java Sat Sep 9 10:35:59 2017
@@ -31,16 +31,17 @@ import org.apache.maven.plugins.annotati
import org.apache.maven.project.MavenProject;
/**
- * Goal that sets a property pointing to the artifact file for each project dependency.
- * For each dependency (direct and transitive) a project property will be set which follows the
- * <code>groupId:artifactId:type:[classifier]</code> form and contains the path to the resolved artifact.
+ * Goal that sets a property pointing to the artifact file for each project dependency. For each dependency (direct and
+ * transitive) a project property will be set which follows the <code>groupId:artifactId:type:[classifier]</code> form
+ * and contains the path to the resolved artifact.
*
* @author Paul Gier
* @version $Id$
* @since 2.2
*/
-@Mojo( name = "properties", requiresDependencyResolution = ResolutionScope.TEST,
- defaultPhase = LifecyclePhase.INITIALIZE, threadSafe = true )
+//CHECKSTYLE_OFF: LineLength
+@Mojo( name = "properties", requiresDependencyResolution = ResolutionScope.TEST, defaultPhase = LifecyclePhase.INITIALIZE, threadSafe = true )
+//CHECKSTYLE_ON: LineLength
public class PropertiesMojo
extends AbstractMojo
{
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java Sat Sep 9 10:35:59 2017
@@ -296,7 +296,8 @@ public class PurgeLocalRepositoryMojo
/**
* Includes only snapshot artifacts
*/
- private class SnapshotsFilter extends AbstractFilter
+ private class SnapshotsFilter
+ extends AbstractFilter
{
@Override
public boolean accept( Node node, List<Node> parents )
@@ -371,8 +372,7 @@ public class PurgeLocalRepositoryMojo
{
List<Dependency> dependencies = project.getDependencies();
- TransformableFilter dependencyFilter =
- createPurgeArtifactsFilter( project, dependencies, purgedArtifacts );
+ TransformableFilter dependencyFilter = createPurgeArtifactsFilter( project, dependencies, purgedArtifacts );
Set<Artifact> resolvedArtifactsToPurge =
getFilteredResolvedArtifacts( project, dependencies, dependencyFilter );
@@ -524,7 +524,7 @@ public class PurgeLocalRepositoryMojo
}
List<String> exclusions = new ArrayList<String>( reactorProjects.size() );
- // It doesn't make sense to include projects from the reactor here since they're likely not able to be resolved
+ // It doesn't make sense to include projects from the reactor here since they're likely not able to be resolved
for ( MavenProject reactorProject : reactorProjects )
{
exclusions.add( toPatternExcludes( reactorProject.getArtifact() ) );
@@ -576,8 +576,8 @@ public class PurgeLocalRepositoryMojo
try
{
Iterable<ArtifactResult> results =
- dependencyResolver.resolveDependencies( session.getProjectBuildingRequest(),
- project.getModel(), filter );
+ dependencyResolver.resolveDependencies( session.getProjectBuildingRequest(), project.getModel(),
+ filter );
Set<Artifact> resolvedArtifacts = new LinkedHashSet<Artifact>();
@@ -591,8 +591,8 @@ public class PurgeLocalRepositoryMojo
catch ( DependencyResolverException e )
{
getLog().info( "Unable to resolve all dependencies for: " + project.getGroupId() + ":"
- + project.getArtifactId() + ":" + project.getVersion()
- + ". Falling back to non-transitive mode for initial artifact resolution." );
+ + project.getArtifactId() + ":" + project.getVersion()
+ + ". Falling back to non-transitive mode for initial artifact resolution." );
}
Set<Artifact> resolvedArtifacts = new LinkedHashSet<Artifact>();
@@ -667,8 +667,10 @@ public class PurgeLocalRepositoryMojo
{
try
{
+ //CHECKSTYLE_OFF: LineLength
artifactResolver.resolveArtifact( session.getProjectBuildingRequest(),
- org.apache.maven.shared.artifact.TransferUtils.toArtifactCoordinate( artifact ) );
+ org.apache.maven.shared.artifact.TransferUtils.toArtifactCoordinate( artifact ) );
+ //CHECKSTYLE_ON: LineLength
}
catch ( ArtifactResolverException e )
{
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AbstractAnalyzeMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AbstractAnalyzeMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AbstractAnalyzeMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AbstractAnalyzeMojo.java Sat Sep 9 10:35:59 2017
@@ -74,12 +74,10 @@ public abstract class AbstractAnalyzeMoj
private MavenProject project;
/**
- * Specify the project dependency analyzer to use (plexus component role-hint).
- * By default, <a href="/shared/maven-dependency-analyzer/">maven-dependency-analyzer</a> is used.
- *
- * To use this, you must declare a dependency for this plugin that contains the code for the
- * analyzer. The analyzer must have a declared Plexus role name, and you specify the role name
- * here.
+ * Specify the project dependency analyzer to use (plexus component role-hint). By default,
+ * <a href="/shared/maven-dependency-analyzer/">maven-dependency-analyzer</a> is used. To use this, you must declare
+ * a dependency for this plugin that contains the code for the analyzer. The analyzer must have a declared Plexus
+ * role name, and you specify the role name here.
*
* @since 2.2
*/
@@ -145,8 +143,8 @@ public abstract class AbstractAnalyzeMoj
private File outputDirectory;
/**
- * Force dependencies as used, to override incomplete result caused by bytecode-level analysis.
- * Dependency format is <code>groupId:artifactId</code>.
+ * Force dependencies as used, to override incomplete result caused by bytecode-level analysis. Dependency format is
+ * <code>groupId:artifactId</code>.
*
* @since 2.6
*/
@@ -162,70 +160,65 @@ public abstract class AbstractAnalyzeMoj
private boolean skip;
/**
- * List of dependencies that will be ignored.
- *
- * Any dependency on this list will be excluded from the "declared but unused" and the "used but undeclared" list.
- *
- * The filter syntax is:
+ * List of dependencies that will be ignored. Any dependency on this list will be excluded from the "declared but
+ * unused" and the "used but undeclared" list. The filter syntax is:
*
* <pre>
* [groupId]:[artifactId]:[type]:[version]
* </pre>
*
* where each pattern segment is optional and supports full and partial <code>*</code> wildcards. An empty pattern
- * segment is treated as an implicit wildcard.
- * *
- * <p>For example, <code>org.apache.*</code> will match all artifacts whose group id starts with
- * <code>org.apache.</code>, and <code>:::*-SNAPSHOT</code> will match all snapshot artifacts.</p>
+ * segment is treated as an implicit wildcard. *
+ * <p>
+ * For example, <code>org.apache.*</code> will match all artifacts whose group id starts with
+ * <code>org.apache.</code>, and <code>:::*-SNAPSHOT</code> will match all snapshot artifacts.
+ * </p>
*
* @since 2.10
* @see StrictPatternIncludesArtifactFilter
*/
@Parameter
- private String [] ignoredDependencies = new String[0];
+ private String[] ignoredDependencies = new String[0];
/**
- * List of dependencies that will be ignored if they are used but undeclared.
- *
- * The filter syntax is:
+ * List of dependencies that will be ignored if they are used but undeclared. The filter syntax is:
*
* <pre>
* [groupId]:[artifactId]:[type]:[version]
* </pre>
*
* where each pattern segment is optional and supports full and partial <code>*</code> wildcards. An empty pattern
- * segment is treated as an implicit wildcard.
- * *
- * <p>For example, <code>org.apache.*</code> will match all artifacts whose group id starts with
- * <code>org.apache.</code>, and <code>:::*-SNAPSHOT</code> will match all snapshot artifacts.</p>
+ * segment is treated as an implicit wildcard. *
+ * <p>
+ * For example, <code>org.apache.*</code> will match all artifacts whose group id starts with
+ * <code>org.apache.</code>, and <code>:::*-SNAPSHOT</code> will match all snapshot artifacts.
+ * </p>
*
* @since 2.10
* @see StrictPatternIncludesArtifactFilter
*/
@Parameter
- private String [] ignoredUsedUndeclaredDependencies = new String[0];
+ private String[] ignoredUsedUndeclaredDependencies = new String[0];
/**
- * List of dependencies that will be ignored if they are declared but unused.
- *
- * The filter syntax is:
+ * List of dependencies that will be ignored if they are declared but unused. The filter syntax is:
*
* <pre>
* [groupId]:[artifactId]:[type]:[version]
* </pre>
*
* where each pattern segment is optional and supports full and partial <code>*</code> wildcards. An empty pattern
- * segment is treated as an implicit wildcard.
- * *
- * <p>For example, <code>org.apache.*</code> will match all artifacts whose group id starts with
- * <code>org.apache.</code>, and <code>:::*-SNAPSHOT</code> will match all snapshot artifacts.</p>
+ * segment is treated as an implicit wildcard. *
+ * <p>
+ * For example, <code>org.apache.*</code> will match all artifacts whose group id starts with
+ * <code>org.apache.</code>, and <code>:::*-SNAPSHOT</code> will match all snapshot artifacts.
+ * </p>
*
* @since 2.10
* @see StrictPatternIncludesArtifactFilter
*/
@Parameter
- private String [] ignoredUnusedDeclaredDependencies = new String[0];
-
+ private String[] ignoredUnusedDeclaredDependencies = new String[0];
// Mojo methods -----------------------------------------------------------
@@ -277,9 +270,8 @@ public abstract class AbstractAnalyzeMoj
}
catch ( Exception exception )
{
- throw new MojoExecutionException(
- "Failed to instantiate ProjectDependencyAnalyser with role " + role + " / role-hint " + roleHint,
- exception );
+ throw new MojoExecutionException( "Failed to instantiate ProjectDependencyAnalyser with role " + role
+ + " / role-hint " + roleHint, exception );
}
}
@@ -336,7 +328,6 @@ public abstract class AbstractAnalyzeMoj
boolean reported = false;
boolean warning = false;
-
if ( verbose && !usedDeclared.isEmpty() )
{
getLog().info( "Used declared dependencies found:" );
@@ -480,10 +471,20 @@ public abstract class AbstractAnalyzeMoj
// called because artifact will set the version to -SNAPSHOT only if I do this. MNG-2961
artifact.isSnapshot();
- buf.append( scriptableFlag ).append( ":" ).append( pomFile ).append( ":" )
- .append( artifact.getDependencyConflictId() ).append( ":" ).append( artifact.getClassifier() )
- .append( ":" ).append( artifact.getBaseVersion() ).append( ":" ).append( artifact.getScope() )
+ //CHECKSTYLE_OFF: LineLength
+ buf.append( scriptableFlag )
+ .append( ":" )
+ .append( pomFile )
+ .append( ":" )
+ .append( artifact.getDependencyConflictId() )
+ .append( ":" )
+ .append( artifact.getClassifier() )
+ .append( ":" )
+ .append( artifact.getBaseVersion() )
+ .append( ":" )
+ .append( artifact.getScope() )
.append( "\n" );
+ //CHECKSTYLE_ON: LineLength
}
getLog().info( "\n" + buf );
}
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDepMgt.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDepMgt.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDepMgt.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDepMgt.java Sat Sep 9 10:35:59 2017
@@ -40,14 +40,11 @@ import org.apache.maven.project.MavenPro
import org.codehaus.plexus.util.StringUtils;
/**
- * This mojo looks at the dependencies after final resolution and looks for
- * mismatches in your dependencyManagement section. In versions of maven prior
- * to 2.0.6, it was possible to inherit versions that didn't match your
- * dependencyManagement. See <a
- * href="https://issues.apache.org/jira/browse/MNG-1577">MNG-1577</a> for more info.
- * This mojo is also useful for just detecting projects that override the
- * dependencyManagement directly. Set ignoreDirect to false to detect these
- * otherwise normal conditions.
+ * This mojo looks at the dependencies after final resolution and looks for mismatches in your dependencyManagement
+ * section. In versions of maven prior to 2.0.6, it was possible to inherit versions that didn't match your
+ * dependencyManagement. See <a href="https://issues.apache.org/jira/browse/MNG-1577">MNG-1577</a> for more info. This
+ * mojo is also useful for just detecting projects that override the dependencyManagement directly. Set ignoreDirect to
+ * false to detect these otherwise normal conditions.
*
* @author <a href="mailto:brianefox@gmail.com">Brian Fox</a>
* @version $Id$
@@ -150,8 +147,7 @@ public class AnalyzeDepMgt
}
// get dependencies for the project (including transitive)
- Set<Artifact> allDependencyArtifacts =
- new LinkedHashSet<Artifact>( project.getArtifacts() );
+ Set<Artifact> allDependencyArtifacts = new LinkedHashSet<Artifact>( project.getArtifacts() );
// don't warn if a dependency that is directly listed overrides
// depMgt. That's ok.
@@ -167,8 +163,8 @@ public class AnalyzeDepMgt
for ( Artifact exclusion : exclusionErrors )
{
getLog().info( StringUtils.stripEnd( getArtifactManagementKey( exclusion ), ":" )
- + " was excluded in DepMgt, but version " + exclusion.getVersion()
- + " has been found in the dependency tree." );
+ + " was excluded in DepMgt, but version " + exclusion.getVersion()
+ + " has been found in the dependency tree." );
foundError = true;
}
@@ -193,12 +189,10 @@ public class AnalyzeDepMgt
}
/**
- * Returns a map of the exclusions using the Dependency ManagementKey as the
- * keyset.
+ * Returns a map of the exclusions using the Dependency ManagementKey as the keyset.
*
* @param exclusionList to be added to the map.
- * @return a map of the exclusions using the Dependency ManagementKey as the
- * keyset.
+ * @return a map of the exclusions using the Dependency ManagementKey as the keyset.
*/
public Map<String, Exclusion> addExclusions( List<Exclusion> exclusionList )
{
@@ -214,11 +208,10 @@ public class AnalyzeDepMgt
}
/**
- * Returns a List of the artifacts that should have been excluded, but were
- * found in the dependency tree.
+ * Returns a List of the artifacts that should have been excluded, but were found in the dependency tree.
*
- * @param exclusions a map of the DependencyManagement exclusions, with the
- * ManagementKey as the key and Dependency as the value.
+ * @param exclusions a map of the DependencyManagement exclusions, with the ManagementKey as the key and Dependency
+ * as the value.
* @param allDependencyArtifacts resolved artifacts to be compared.
* @return list of artifacts that should have been excluded.
*/
@@ -248,14 +241,11 @@ public class AnalyzeDepMgt
}
/**
- * Calculate the mismatches between the DependencyManagement and resolved
- * artifacts
+ * Calculate the mismatches between the DependencyManagement and resolved artifacts
*
- * @param depMgtMap contains the Dependency.GetManagementKey as the keyset for
- * quick lookup.
+ * @param depMgtMap contains the Dependency.GetManagementKey as the keyset for quick lookup.
* @param allDependencyArtifacts contains the set of all artifacts to compare.
- * @return a map containing the resolved artifact as the key and the listed
- * dependency as the value.
+ * @return a map containing the resolved artifact as the key and the listed dependency as the value.
*/
public Map<Artifact, Dependency> getMismatch( Map<String, Dependency> depMgtMap,
Set<Artifact> allDependencyArtifacts )
@@ -267,11 +257,11 @@ public class AnalyzeDepMgt
Dependency depFromDepMgt = depMgtMap.get( getArtifactManagementKey( dependencyArtifact ) );
if ( depFromDepMgt != null )
{
- //workaround for MNG-2961
+ // workaround for MNG-2961
dependencyArtifact.isSnapshot();
if ( depFromDepMgt.getVersion() != null
- && !depFromDepMgt.getVersion().equals( dependencyArtifact.getBaseVersion() ) )
+ && !depFromDepMgt.getVersion().equals( dependencyArtifact.getBaseVersion() ) )
{
mismatchMap.put( dependencyArtifact, depFromDepMgt );
}
@@ -281,20 +271,20 @@ public class AnalyzeDepMgt
}
/**
- * This function displays the log to the screen showing the versions and
- * information about the artifacts that don't match.
+ * This function displays the log to the screen showing the versions and information about the artifacts that don't
+ * match.
*
- * @param dependencyArtifact the artifact that was resolved.
+ * @param dependencyArtifact the artifact that was resolved.
* @param dependencyFromDepMgt the dependency listed in the DependencyManagement section.
- * @throws MojoExecutionException
+ * @throws MojoExecutionException in case of errors.
*/
public void logMismatch( Artifact dependencyArtifact, Dependency dependencyFromDepMgt )
throws MojoExecutionException
{
if ( dependencyArtifact == null || dependencyFromDepMgt == null )
{
- throw new MojoExecutionException(
- "Invalid params: Artifact: " + dependencyArtifact + " Dependency: " + dependencyFromDepMgt );
+ throw new MojoExecutionException( "Invalid params: Artifact: " + dependencyArtifact + " Dependency: "
+ + dependencyFromDepMgt );
}
getLog().info( "\tDependency: " + StringUtils.stripEnd( dependencyFromDepMgt.getManagementKey(), ":" ) );
@@ -310,8 +300,8 @@ public class AnalyzeDepMgt
*/
public String getArtifactManagementKey( Artifact artifact )
{
- return artifact.getGroupId() + ":" + artifact.getArtifactId() + ":" + artifact.getType() + ( (
- artifact.getClassifier() != null ) ? ":" + artifact.getClassifier() : "" );
+ return artifact.getGroupId() + ":" + artifact.getArtifactId() + ":" + artifact.getType()
+ + ( ( artifact.getClassifier() != null ) ? ":" + artifact.getClassifier() : "" );
}
/**
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDuplicateMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDuplicateMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDuplicateMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDuplicateMojo.java Sat Sep 9 10:35:59 2017
@@ -168,7 +168,10 @@ public class AnalyzeDuplicateMojo
modelDependencies2.add( dep.getManagementKey() );
}
- return new LinkedHashSet<String>(
- CollectionUtils.disjunction( modelDependencies2, new LinkedHashSet<String>( modelDependencies2 ) ) );
+ //@formatter:off
+ return new LinkedHashSet<String>(
+ CollectionUtils.disjunction( modelDependencies2, new LinkedHashSet<String>( modelDependencies2 ) )
+ );
+ //@formatter:on
}
}
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeMojo.java Sat Sep 9 10:35:59 2017
@@ -28,10 +28,11 @@ import org.apache.maven.plugins.annotati
* Analyzes the dependencies of this project and determines which are: used and declared; used and undeclared; unused
* and declared. This goal is intended to be used standalone, thus it always executes the <code>test-compile</code>
* phase - use the <code>dependency:analyze-only</code> goal instead when participating in the build lifecycle.
- *
- * <p>By default, <a href="http://maven.apache.org/shared/maven-dependency-analyzer/">maven-dependency-analyzer</a> is
- * used to perform the analysis, with limitations due to the fact that it works at bytecode level, but any
- * analyzer can be plugged in through <code>analyzer</code> parameter.</p>
+ * <p>
+ * By default, <a href="http://maven.apache.org/shared/maven-dependency-analyzer/">maven-dependency-analyzer</a> is used
+ * to perform the analysis, with limitations due to the fact that it works at bytecode level, but any analyzer can be
+ * plugged in through <code>analyzer</code> parameter.
+ * </p>
*
* @author <a href="mailto:markhobson@gmail.com">Mark Hobson</a>
* @version $Id$
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeOnlyMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeOnlyMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeOnlyMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeOnlyMojo.java Sat Sep 9 10:35:59 2017
@@ -26,20 +26,27 @@ import org.apache.maven.plugins.annotati
/**
* Analyzes the dependencies of this project and determines which are: used and declared; used and undeclared; unused
* and declared. This goal is intended to be used in the build lifecycle, thus it assumes that the
- * <code>test-compile</code> phase has been executed - use the <code>dependency:analyze</code> goal instead when
- * running standalone.
- *
- * <p>By default, <a href="http://maven.apache.org/shared/maven-dependency-analyzer/">maven-dependency-analyzer</a> is
- * used to perform the analysis, with limitations due to the fact that it works at bytecode level, but any
- * analyzer can be plugged in through <code>analyzer</code> parameter.</p>
+ * <code>test-compile</code> phase has been executed - use the <code>dependency:analyze</code> goal instead when running
+ * standalone.
+ * <p>
+ * By default, <a href="http://maven.apache.org/shared/maven-dependency-analyzer/">maven-dependency-analyzer</a> is used
+ * to perform the analysis, with limitations due to the fact that it works at bytecode level, but any analyzer can be
+ * plugged in through <code>analyzer</code> parameter.
+ * </p>
*
* @author <a href="mailto:markhobson@gmail.com">Mark Hobson</a>
* @version $Id$
* @see AnalyzeMojo
* @since 2.0
*/
-@Mojo( name = "analyze-only", requiresDependencyResolution = ResolutionScope.TEST,
- defaultPhase = LifecyclePhase.VERIFY, threadSafe = true )
+//@formatter:off
+@Mojo(
+ name = "analyze-only",
+ requiresDependencyResolution = ResolutionScope.TEST,
+ defaultPhase = LifecyclePhase.VERIFY,
+ threadSafe = true
+)
+//@formatter:on
public class AnalyzeOnlyMojo
extends AbstractAnalyzeMojo
{
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportMojo.java Sat Sep 9 10:35:59 2017
@@ -80,14 +80,15 @@ public class AnalyzeReportMojo
/**
* Ignore Runtime/Provided/Test/System scopes for unused dependency analysis
+ *
* @since 2.2
*/
@Parameter( property = "ignoreNonCompile", defaultValue = "false" )
private boolean ignoreNonCompile;
/**
- * Force dependencies as used, to override incomplete result caused by bytecode-level analysis.
- * Dependency format is <code>groupId:artifactId</code>.
+ * Force dependencies as used, to override incomplete result caused by bytecode-level analysis. Dependency format is
+ * <code>groupId:artifactId</code>.
*
* @since 2.6
*/
@@ -146,7 +147,7 @@ public class AnalyzeReportMojo
throw new MavenReportException( "Cannot analyze dependencies", exception );
}
- //remove everything that's not in the compile scope
+ // remove everything that's not in the compile scope
if ( ignoreNonCompile )
{
analysis = analysis.ignoreNonCompile();
@@ -225,6 +226,7 @@ public class AnalyzeReportMojo
/**
* @param locale the current locale
+ * @return The resource bundle {@link ResourceBundle}
*/
protected ResourceBundle getBundle( Locale locale )
{
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportView.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportView.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportView.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportView.java Sat Sep 9 10:35:59 2017
@@ -34,6 +34,10 @@ public class AnalyzeReportView
{
/**
* Generates the HTML report.
+ *
+ * @param analysis {@link ProjectDependencyAnalysis}
+ * @param sink {@link Sink}
+ * @param bundle {@link ResourceBundle}
*/
public void generateReport( ProjectDependencyAnalysis analysis, Sink sink, ResourceBundle bundle )
{
@@ -114,6 +118,9 @@ public class AnalyzeReportView
/**
* Generate a table for the given dependencies iterator.
+ *
+ * @param sink {@link Sink}
+ * @param iter {@link Artifact}
*/
public void generateDependenciesTable( Sink sink, Iterator<Artifact> iter )
{
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java Sat Sep 9 10:35:59 2017
@@ -116,7 +116,8 @@ public abstract class AbstractFromConfig
abstract ArtifactItemFilter getMarkedArtifactFilter( ArtifactItem item );
// artifactItems is filled by either field injection or by setArtifact()
- protected void verifyRequirements() throws MojoFailureException
+ protected void verifyRequirements()
+ throws MojoFailureException
{
if ( artifactItems == null || artifactItems.isEmpty() )
{
@@ -133,13 +134,13 @@ public abstract class AbstractFromConfig
* @throws MojoExecutionException with a message if an error occurs.
* @see ArtifactItem
*/
- protected List<ArtifactItem> getProcessedArtifactItems( ProcessArtifactItemsRequest processArtifactItemsRequest )
+ protected List<ArtifactItem> getProcessedArtifactItems( ProcessArtifactItemsRequest processArtifactItemsRequest )
throws MojoExecutionException
{
- boolean removeVersion = processArtifactItemsRequest.isRemoveVersion(), prependGroupId =
- processArtifactItemsRequest.isPrependGroupId(), useBaseVersion =
- processArtifactItemsRequest.isUseBaseVersion();
+ boolean removeVersion = processArtifactItemsRequest.isRemoveVersion(),
+ prependGroupId = processArtifactItemsRequest.isPrependGroupId(),
+ useBaseVersion = processArtifactItemsRequest.isUseBaseVersion();
boolean removeClassifier = processArtifactItemsRequest.isRemoveClassifier();
@@ -267,18 +268,16 @@ public abstract class AbstractFromConfig
{
MavenProject project = getProject();
List<Dependency> deps = project.getDependencies();
- List<Dependency> depMngt = project.getDependencyManagement() == null
- ? Collections.<Dependency>emptyList()
- : project.getDependencyManagement().getDependencies();
+ List<Dependency> depMngt = project.getDependencyManagement() == null ? Collections.<Dependency>emptyList()
+ : project.getDependencyManagement().getDependencies();
if ( !findDependencyVersion( artifact, deps, false )
&& ( project.getDependencyManagement() == null || !findDependencyVersion( artifact, depMngt, false ) )
&& !findDependencyVersion( artifact, deps, true )
&& ( project.getDependencyManagement() == null || !findDependencyVersion( artifact, depMngt, true ) ) )
{
- throw new MojoExecutionException(
- "Unable to find artifact version of " + artifact.getGroupId() + ":" + artifact.getArtifactId()
- + " in either dependency list or in project's dependency management." );
+ throw new MojoExecutionException( "Unable to find artifact version of " + artifact.getGroupId() + ":"
+ + artifact.getArtifactId() + " in either dependency list or in project's dependency management." );
}
}
@@ -286,9 +285,9 @@ public abstract class AbstractFromConfig
* Tries to find missing version from a list of dependencies. If found, the artifact is updated with the correct
* version.
*
- * @param artifact representing configured file.
+ * @param artifact representing configured file.
* @param dependencies list of dependencies to search.
- * @param looseMatch only look at artifactId and groupId
+ * @param looseMatch only look at artifactId and groupId
* @return the found dependency
*/
private boolean findDependencyVersion( ArtifactItem artifact, List<Dependency> dependencies, boolean looseMatch )
@@ -404,9 +403,8 @@ public abstract class AbstractFromConfig
String[] tokens = StringUtils.split( artifact, ":" );
if ( tokens.length < 3 || tokens.length > 5 )
{
- throw new MojoFailureException(
- "Invalid artifact, you must specify groupId:artifactId:version[:packaging[:classifier]] "
- + artifact );
+ throw new MojoFailureException( "Invalid artifact, "
+ + "you must specify groupId:artifactId:version[:packaging[:classifier]] " + artifact );
}
String groupId = tokens[0];
String artifactId = tokens[1];
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java Sat Sep 9 10:35:59 2017
@@ -28,14 +28,14 @@ import org.apache.maven.shared.dependenc
import org.codehaus.plexus.util.StringUtils;
/**
- * ArtifactItem represents information specified in the plugin configuration
- * section for each artifact.
+ * ArtifactItem represents information specified in the plugin configuration section for each artifact.
*
* @since 1.0
* @author <a href="mailto:brianf@apache.org">Brian Fox</a>
* @version $Id$
*/
-public class ArtifactItem implements DependableCoordinate
+public class ArtifactItem
+ implements DependableCoordinate
{
/**
* Group Id of Artifact
@@ -112,14 +112,12 @@ public class ArtifactItem implements Dep
private Artifact artifact;
/**
- * A comma separated list of file patterns to include when unpacking the
- * artifact.
+ * A comma separated list of file patterns to include when unpacking the artifact.
*/
private String includes;
/**
- * A comma separated list of file patterns to exclude when unpacking the
- * artifact.
+ * A comma separated list of file patterns to exclude when unpacking the artifact.
*/
private String excludes;
@@ -156,8 +154,7 @@ public class ArtifactItem implements Dep
}
/**
- * @param artifact
- * The artifactId to set.
+ * @param artifact The artifactId to set.
*/
public void setArtifactId( String artifact )
{
@@ -173,8 +170,7 @@ public class ArtifactItem implements Dep
}
/**
- * @param groupId
- * The groupId to set.
+ * @param groupId The groupId to set.
*/
public void setGroupId( String groupId )
{
@@ -190,8 +186,7 @@ public class ArtifactItem implements Dep
}
/**
- * @param type
- * The type to set.
+ * @param type The type to set.
*/
public void setType( String type )
{
@@ -207,8 +202,7 @@ public class ArtifactItem implements Dep
}
/**
- * @param version
- * The version to set.
+ * @param version The version to set.
*/
public void setVersion( String version )
{
@@ -232,8 +226,7 @@ public class ArtifactItem implements Dep
}
/**
- * @param classifier
- * Classifier.
+ * @param classifier Classifier.
*/
public void setClassifier( String classifier )
{
@@ -249,8 +242,8 @@ public class ArtifactItem implements Dep
}
else
{
- return groupId + ":" + artifactId + ":" + classifier + ":" + StringUtils.defaultString( version, "?" )
- + ":" + type;
+ return groupId + ":" + artifactId + ":" + classifier + ":" + StringUtils.defaultString( version, "?" ) + ":"
+ + type;
}
}
@@ -263,8 +256,7 @@ public class ArtifactItem implements Dep
}
/**
- * @param outputDirectory
- * The outputDirectory to set.
+ * @param outputDirectory The outputDirectory to set.
*/
public void setOutputDirectory( File outputDirectory )
{
@@ -280,8 +272,7 @@ public class ArtifactItem implements Dep
}
/**
- * @param destFileName
- * The destFileName to set.
+ * @param destFileName The destFileName to set.
*/
public void setDestFileName( String destFileName )
{
@@ -297,8 +288,7 @@ public class ArtifactItem implements Dep
}
/**
- * @param needsProcessing
- * The needsProcessing to set.
+ * @param needsProcessing The needsProcessing to set.
*/
public void setNeedsProcessing( boolean needsProcessing )
{
@@ -314,8 +304,7 @@ public class ArtifactItem implements Dep
}
/**
- * @param overWrite
- * The overWrite to set.
+ * @param overWrite The overWrite to set.
*/
public void setOverWrite( String overWrite )
{
@@ -349,8 +338,7 @@ public class ArtifactItem implements Dep
}
/**
- * @param artifact
- * The artifact to set.
+ * @param artifact The artifact to set.
*/
public void setArtifact( Artifact artifact )
{
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java Sat Sep 9 10:35:59 2017
@@ -37,7 +37,7 @@ import java.util.List;
* @version $Id$
* @since 1.0
*/
-@Mojo( name = "copy", defaultPhase = LifecyclePhase.PROCESS_SOURCES, requiresProject = false, threadSafe = true )
+@Mojo( name = "copy", defaultPhase = LifecyclePhase.PROCESS_SOURCES, requiresProject = false, threadSafe = true )
public class CopyMojo
extends AbstractFromConfigurationMojo
{
@@ -56,6 +56,7 @@ public class CopyMojo
/**
* Prepend artifact groupId during copy
+ *
* @since 2.7
*/
@Parameter( property = "mdep.prependGroupId", defaultValue = "false" )
@@ -63,17 +64,17 @@ public class CopyMojo
/**
* Use artifact baseVersion during copy
+ *
* @since 2.7
*/
@Parameter( property = "mdep.useBaseVersion", defaultValue = "false" )
private boolean useBaseVersion = false;
/**
- * The artifact to copy from command line. A string of the form
- * groupId:artifactId:version[:packaging[:classifier]]. Use {@link #artifactItems} within the
- * POM configuration.
+ * The artifact to copy from command line. A string of the form groupId:artifactId:version[:packaging[:classifier]].
+ * Use {@link #artifactItems} within the POM configuration.
*/
- @SuppressWarnings( "unused" ) //marker-field, setArtifact(String) does the magic
+ @SuppressWarnings( "unused" ) // marker-field, setArtifact(String) does the magic
@Parameter( property = "artifact" )
private String artifact;
@@ -105,8 +106,8 @@ public class CopyMojo
verifyRequirements();
List<ArtifactItem> theArtifactItems =
- getProcessedArtifactItems( new ProcessArtifactItemsRequest( stripVersion, prependGroupId,
- useBaseVersion, stripClassifier ) );
+ getProcessedArtifactItems( new ProcessArtifactItemsRequest( stripVersion, prependGroupId, useBaseVersion,
+ stripClassifier ) );
for ( ArtifactItem artifactItem : theArtifactItems )
{
if ( artifactItem.isNeedsProcessing() )
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ProcessArtifactItemsRequest.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ProcessArtifactItemsRequest.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ProcessArtifactItemsRequest.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ProcessArtifactItemsRequest.java Sat Sep 9 10:35:59 2017
@@ -30,11 +30,11 @@ public class ProcessArtifactItemsRequest
*/
private boolean removeVersion;
- /**
+ /**
* remove the classifier from the filename.
*/
private boolean removeClassifier;
-
+
/**
* prepend the groupId to the filename.
*/
@@ -79,7 +79,6 @@ public class ProcessArtifactItemsRequest
this.removeClassifier = removeClassifier;
}
-
public ProcessArtifactItemsRequest removeVersion( boolean removeVersion )
{
this.removeVersion = removeVersion;
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java Sat Sep 9 10:35:59 2017
@@ -53,9 +53,8 @@ public class UnpackMojo
/**
* A comma separated list of file patterns to include when unpacking the artifact. i.e.
- * <code>**/*.xml,**/*.properties</code>
- * NOTE: Excludes patterns override the includes.
- * (component code = <code>return isIncluded( name ) AND !isExcluded( name );</code>)
+ * <code>**/*.xml,**/*.properties</code> NOTE: Excludes patterns override the includes. (component code =
+ * <code>return isIncluded( name ) AND !isExcluded( name );</code>)
*
* @since 2.0-alpha-5
*/
@@ -64,9 +63,8 @@ public class UnpackMojo
/**
* A comma separated list of file patterns to exclude when unpacking the artifact. i.e. **\/*.xml,**\/*.properties
- * <code>**/*.xml,**/*.properties</code>
- * NOTE: Excludes patterns override the includes.
- * (component code = <code>return isIncluded( name ) AND !isExcluded( name );</code>)
+ * <code>**/*.xml,**/*.properties</code> NOTE: Excludes patterns override the includes. (component code =
+ * <code>return isIncluded( name ) AND !isExcluded( name );</code>)
*
* @since 2.0-alpha-5
*/
@@ -75,10 +73,10 @@ public class UnpackMojo
/**
* The artifact to unpack from command line. A string of the form
- * <code>groupId:artifactId:version[:packaging[:classifier]]</code>. Use {@link #artifactItems} within the
- * POM configuration.
+ * <code>groupId:artifactId:version[:packaging[:classifier]]</code>. Use {@link #artifactItems} within the POM
+ * configuration.
*/
- @SuppressWarnings( "unused" ) //marker-field, setArtifact(String) does the magic
+ @SuppressWarnings( "unused" ) // marker-field, setArtifact(String) does the magic
@Parameter( property = "artifact" )
private String artifact;
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java Sat Sep 9 10:35:59 2017
@@ -56,8 +56,7 @@ import org.apache.maven.shared.dependenc
import org.codehaus.plexus.util.StringUtils;
/**
- * Class that encapsulates the plugin parameters, and contains methods that
- * handle dependency filtering
+ * Class that encapsulates the plugin parameters, and contains methods that handle dependency filtering
*
* @author <a href="mailto:brianf@apache.org">Brian Fox</a>
* @version $Id$
@@ -108,8 +107,7 @@ public abstract class AbstractDependency
protected boolean excludeTransitive;
/**
- * Comma Separated list of Types to include. Empty String indicates include
- * everything (default).
+ * Comma Separated list of Types to include. Empty String indicates include everything (default).
*
* @since 2.0
*/
@@ -117,8 +115,7 @@ public abstract class AbstractDependency
protected String includeTypes;
/**
- * Comma Separated list of Types to exclude. Empty String indicates don't
- * exclude anything (default).
+ * Comma Separated list of Types to exclude. Empty String indicates don't exclude anything (default).
*
* @since 2.0
*/
@@ -150,8 +147,7 @@ public abstract class AbstractDependency
protected String excludeScope;
/**
- * Comma Separated list of Classifiers to include. Empty String indicates
- * include everything (default).
+ * Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
*
* @since 2.0
*/
@@ -159,8 +155,7 @@ public abstract class AbstractDependency
protected String includeClassifiers;
/**
- * Comma Separated list of Classifiers to exclude. Empty String indicates
- * don't exclude anything (default).
+ * Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
*
* @since 2.0
*/
@@ -176,8 +171,7 @@ public abstract class AbstractDependency
protected String classifier;
/**
- * Specify type to look for when constructing artifact based on classifier.
- * Example: java-source,jar,war
+ * Specify type to look for when constructing artifact based on classifier. Example: java-source,jar,war
*
* @since 2.0
*/
@@ -193,9 +187,7 @@ public abstract class AbstractDependency
protected String excludeArtifactIds;
/**
- * Comma separated list of Artifact names to include.
- * Empty String indicates include
- * everything (default).
+ * Comma separated list of Artifact names to include. Empty String indicates include everything (default).
*
* @since 2.0
*/
@@ -211,9 +203,7 @@ public abstract class AbstractDependency
protected String excludeGroupIds;
/**
- * Comma separated list of GroupIds to include.
- * Empty String indicates include
- * everything (default).
+ * Comma separated list of GroupIds to include. Empty String indicates include everything (default).
*
* @since 2.0
*/
@@ -225,8 +215,9 @@ public abstract class AbstractDependency
*
* @since 2.0
*/
- @Parameter( property = "markersDirectory",
- defaultValue = "${project.build.directory}/dependency-maven-plugin-markers" )
+ //CHECKSTYLE_OFF: LineLength
+ @Parameter( property = "markersDirectory", defaultValue = "${project.build.directory}/dependency-maven-plugin-markers" )
+ //CHECKSTYLE_ON: LineLength
protected File markersDirectory;
/**
@@ -253,8 +244,9 @@ public abstract class AbstractDependency
/**
* Retrieves dependencies, either direct only or all including transitive.
*
+ * @param stopOnFailure true to fail if resolution does not work or false not to fail.
* @return A set of artifacts
- * @throws MojoExecutionException
+ * @throws MojoExecutionException in case of errors.
*/
protected Set<Artifact> getResolvedDependencies( boolean stopOnFailure )
throws MojoExecutionException
@@ -265,6 +257,11 @@ public abstract class AbstractDependency
return status.getResolvedDependencies();
}
+ /**
+ * @param stopOnFailure true/false.
+ * @return {@link DependencyStatusSets}
+ * @throws MojoExecutionException in case of an error.
+ */
protected DependencyStatusSets getDependencySets( boolean stopOnFailure )
throws MojoExecutionException
{
@@ -272,14 +269,13 @@ public abstract class AbstractDependency
}
/**
- * Method creates filters and filters the projects dependencies. This method
- * also transforms the dependencies if classifier is set. The dependencies
- * are filtered in least specific to most specific order
- *
- * @param stopOnFailure
- * @return DependencyStatusSets - Bean of TreeSets that contains information
- * on the projects dependencies
- * @throws MojoExecutionException
+ * Method creates filters and filters the projects dependencies. This method also transforms the dependencies if
+ * classifier is set. The dependencies are filtered in least specific to most specific order
+ *
+ * @param stopOnFailure true to fail if artifacts can't be resolved false otherwise.
+ * @param includeParents <code>true</code> if parents should be included or not <code>false</code>.
+ * @return DependencyStatusSets - Bean of TreeSets that contains information on the projects dependencies
+ * @throws MojoExecutionException in case of errors.
*/
protected DependencyStatusSets getDependencySets( boolean stopOnFailure, boolean includeParents )
throws MojoExecutionException
@@ -384,14 +380,14 @@ public abstract class AbstractDependency
}
}
}
+
/**
* Transform artifacts
*
- * @param artifacts
- * @param stopOnFailure
- * @return DependencyStatusSets - Bean of TreeSets that contains information
- * on the projects dependencies
- * @throws MojoExecutionException
+ * @param artifacts set of artifacts {@link Artifact}.
+ * @param stopOnFailure true/false.
+ * @return DependencyStatusSets - Bean of TreeSets that contains information on the projects dependencies
+ * @throws MojoExecutionException in case of an error.
*/
protected DependencyStatusSets getClassifierTranslatedDependencies( Set<Artifact> artifacts, boolean stopOnFailure )
throws MojoExecutionException
@@ -432,9 +428,9 @@ public abstract class AbstractDependency
/**
* Filter the marked dependencies
*
- * @param artifacts
- * @return status set
- * @throws MojoExecutionException
+ * @param artifacts The artifacts set {@link Artifact}.
+ * @return status set {@link DependencyStatusSets}.
+ * @throws MojoExecutionException in case of an error.
*/
protected DependencyStatusSets filterMarkedDependencies( Set<Artifact> artifacts )
throws MojoExecutionException
@@ -462,9 +458,15 @@ public abstract class AbstractDependency
return new DependencyStatusSets( unMarkedArtifacts, null, skippedArtifacts );
}
-
+ /**
+ * @param coordinates The set of artifact coordinates{@link ArtifactCoordinate}.
+ * @param stopOnFailure <code>true</code> if we should fail with exception if an artifact couldn't be resolved
+ * <code>false</code> otherwise.
+ * @return the resolved artifacts. {@link Artifact}.
+ * @throws MojoExecutionException in case of error.
+ */
protected Set<Artifact> resolve( Set<ArtifactCoordinate> coordinates, boolean stopOnFailure )
- throws MojoExecutionException
+ throws MojoExecutionException
{
ProjectBuildingRequest buildingRequest = newResolveArtifactProjectBuildingRequest();
@@ -489,6 +491,7 @@ public abstract class AbstractDependency
}
return resolvedArtifacts;
}
+
/**
* @return Returns the markersDirectory.
*/
@@ -516,8 +519,7 @@ public abstract class AbstractDependency
}
/**
- * @param prependGroupId -
- * true if the groupId must be prepended during the copy.
+ * @param prependGroupId - true if the groupId must be prepended during the copy.
*/
public void setPrependGroupId( boolean prependGroupId )
{
Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractFromDependenciesMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractFromDependenciesMojo.java?rev=1807877&r1=1807876&r2=1807877&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractFromDependenciesMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractFromDependenciesMojo.java Sat Sep 9 10:35:59 2017
@@ -24,8 +24,7 @@ import org.apache.maven.plugins.annotati
import java.io.File;
/**
- * Abstract Parent class used by mojos that get Artifact information from the
- * project dependencies.
+ * Abstract Parent class used by mojos that get Artifact information from the project dependencies.
*
* @author <a href="mailto:brianf@apache.org">Brian Fox</a>
* @version $Id$
@@ -46,7 +45,7 @@ public abstract class AbstractFromDepend
*/
@Parameter( property = "mdep.stripVersion", defaultValue = "false" )
protected boolean stripVersion = false;
-
+
/**
* Strip artifact classifier during copy
*/
@@ -54,8 +53,16 @@ public abstract class AbstractFromDepend
protected boolean stripClassifier = false;
/**
+ * <p>
* Place each artifact in the same directory layout as a default repository.
- * <br/>example: /outputDirectory/junit/junit/3.8.1/junit-3.8.1.jar
+ * </p>
+ * <p>
+ * example:
+ * </p>
+ *
+ * <pre>
+ * /outputDirectory/junit/junit/3.8.1/junit-3.8.1.jar
+ * </pre>
*
* @since 2.0-alpha-2
*/
@@ -63,8 +70,8 @@ public abstract class AbstractFromDepend
protected boolean useRepositoryLayout;
/**
- * Place each type of file in a separate subdirectory. (example
- * /outputDirectory/runtime /outputDirectory/provided etc)
+ * Place each type of file in a separate subdirectory. (example /outputDirectory/runtime /outputDirectory/provided
+ * etc)
*
* @since 2.2
*/
@@ -72,8 +79,7 @@ public abstract class AbstractFromDepend
protected boolean useSubDirectoryPerScope;
/**
- * Place each type of file in a separate subdirectory. (example
- * /outputDirectory/jars /outputDirectory/wars etc)
+ * Place each type of file in a separate subdirectory. (example /outputDirectory/jars /outputDirectory/wars etc)
*
* @since 2.0-alpha-1
*/
@@ -81,8 +87,7 @@ public abstract class AbstractFromDepend
protected boolean useSubDirectoryPerType;
/**
- * Place each file in a separate subdirectory. (example
- * <code>/outputDirectory/junit-3.8.1-jar</code>)
+ * Place each file in a separate subdirectory. (example <code>/outputDirectory/junit-3.8.1-jar</code>)
*
* @since 2.0-alpha-1
*/
@@ -190,8 +195,7 @@ public abstract class AbstractFromDepend
}
/**
- * @param useRepositoryLayout -
- * true if dependencies must be planted in a repository layout
+ * @param useRepositoryLayout - true if dependencies must be planted in a repository layout
*/
public void setUseRepositoryLayout( boolean useRepositoryLayout )
{