Author: khmarbaise
Date: Sat Dec 13 17:56:59 2014
New Revision: 1645339
URL: http://svn.apache.org/r1645339
Log:
Cleaned up code to remove checkstyle reported warnings/errors.
Modified:
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/AttachArtifactTask.java
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/DependencyFilesetsTask.java
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/SpecificScopesArtifactFilter.java
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/TypesArtifactFilter.java
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/VersionMapper.java
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/plugin/antrun/AntRunMojo.java
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/plugin/antrun/AntrunXmlPlexusConfigurationWriter.java
Modified:
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/AttachArtifactTask.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/AttachArtifactTask.java?rev=1645339&r1=1645338&r2=1645339&view=diff
==============================================================================
---
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/AttachArtifactTask.java
(original)
+++
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/AttachArtifactTask.java
Sat Dec 13 17:56:59 2014
@@ -61,6 +61,7 @@ public class AttachArtifactTask
*/
private String type;
+ /** {@inheritDoc} */
public void execute()
{
if ( file == null )
@@ -95,41 +96,65 @@ public class AttachArtifactTask
projectHelper.attachArtifact( mavenProject, type, classifier, file );
}
+ /**
+ * @return {@link #file}
+ */
public File getFile()
{
return file;
}
+ /**
+ * @param file {@link #file}
+ */
public void setFile( File file )
{
this.file = file;
}
+ /**
+ * @return {@link #mavenProjectRefId}
+ */
public String getMavenProjectRefId()
{
return mavenProjectRefId;
}
+ /**
+ * @param mavenProjectRefId {@link #mavenProjectRefId}
+ */
public void setMavenProjectRefId( String mavenProjectRefId )
{
this.mavenProjectRefId = mavenProjectRefId;
}
+ /**
+ * @return {@link #classifier}
+ */
public String getClassifier()
{
return classifier;
}
+ /**
+ * @param classifier {@link #classifier}
+ */
public void setClassifier( String classifier )
{
this.classifier = classifier;
}
+ /**
+ * @return {@link #type}
+ */
public String getType()
{
return type;
}
+ /**
+ * @param type {@link #type}
+ */
public void setType( String type )
{
this.type = type;
Modified:
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/DependencyFilesetsTask.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/DependencyFilesetsTask.java?rev=1645339&r1=1645338&r2=1645339&view=diff
==============================================================================
---
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/DependencyFilesetsTask.java
(original)
+++
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/DependencyFilesetsTask.java
Sat Dec 13 17:56:59 2014
@@ -44,6 +44,9 @@ public class DependencyFilesetsTask
extends Task
{
+ /**
+ * The default project dependencies id.
+ */
public static final String DEFAULT_PROJECT_DEPENDENCIES_ID =
"maven.project.dependencies";
/**
@@ -56,11 +59,17 @@ public class DependencyFilesetsTask
*/
private String projectDependenciesId = DEFAULT_PROJECT_DEPENDENCIES_ID;
+ /**
+ * @return {@link #projectDependenciesId}
+ */
public String getProjectDependenciesId()
{
return projectDependenciesId;
}
+ /**
+ * @param projectDependenciesId {@link #projectDependenciesId}
+ */
public void setProjectDependenciesId( String projectDependenciesId )
{
this.projectDependenciesId = projectDependenciesId;
@@ -81,11 +90,15 @@ public class DependencyFilesetsTask
*/
private String scopes = "";
+ /**
+ * Create instance.
+ */
public DependencyFilesetsTask()
{
}
+ /** {@inheritDoc} */
public void execute()
{
if ( this.getProject().getReference( mavenProjectId ) == null )
@@ -119,16 +132,25 @@ public class DependencyFilesetsTask
getProject().addReference( ( getPrefix() + projectDependenciesId ),
dependenciesFileSet );
}
+ /**
+ * @return {@link #mavenProjectId}
+ */
public String getMavenProjectId()
{
return mavenProjectId;
}
+ /**
+ * @param mavenProjectId {@link #mavenProjectId}
+ */
public void setMavenProjectId( String mavenProjectId )
{
this.mavenProjectId = mavenProjectId;
}
+ /**
+ * @return {@link #prefix}
+ */
public String getPrefix()
{
if ( prefix == null )
@@ -140,27 +162,40 @@ public class DependencyFilesetsTask
/**
* Prefix to be added to each of the dependency filesets. Default is empty
string.
+ * @param prefix {@link #prefix}
*/
public void setPrefix( String prefix )
{
this.prefix = prefix;
}
+ /**
+ * @return {@link #types}
+ */
public String getTypes()
{
return types;
}
+ /**
+ * @param types {@link #types}
+ */
public void setTypes( String types )
{
this.types = types;
}
+ /**
+ * @return {@link #scopes}
+ */
public String getScopes()
{
return scopes;
}
+ /**
+ * @param scopes {@link #scopes}
+ */
public void setScopes( String scopes )
{
this.scopes = scopes;
@@ -169,8 +204,8 @@ public class DependencyFilesetsTask
/**
* Filter a set of artifacts using the scopes and type filters.
*
- * @param artifacts
- * @return
+ * @param artifacts {@link Artifact} set.
+ * @return The set of filtered artifacts.
*/
public Set<Artifact> filterArtifacts( Set<Artifact> artifacts )
{
Modified:
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/SpecificScopesArtifactFilter.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/SpecificScopesArtifactFilter.java?rev=1645339&r1=1645338&r2=1645339&view=diff
==============================================================================
---
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/SpecificScopesArtifactFilter.java
(original)
+++
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/SpecificScopesArtifactFilter.java
Sat Dec 13 17:56:59 2014
@@ -76,6 +76,7 @@ public class SpecificScopesArtifactFilte
}
}
+ /** {@inheritDoc} */
public boolean include( Artifact artifact )
{
if ( Artifact.SCOPE_COMPILE.equals( artifact.getScope() ) )
Modified:
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/TypesArtifactFilter.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/TypesArtifactFilter.java?rev=1645339&r1=1645338&r2=1645339&view=diff
==============================================================================
---
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/TypesArtifactFilter.java
(original)
+++
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/TypesArtifactFilter.java
Sat Dec 13 17:56:59 2014
@@ -36,7 +36,7 @@ public class TypesArtifactFilter
/**
* Accepts a comma separated list of types
*
- * @param types
+ * @param types The types.
*/
public TypesArtifactFilter( String types )
{
@@ -49,6 +49,7 @@ public class TypesArtifactFilter
}
}
+ /** {@inheritDoc} */
public boolean include( Artifact artifact )
{
String artifactType = artifact.getType();
Modified:
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/VersionMapper.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/VersionMapper.java?rev=1645339&r1=1645338&r2=1645339&view=diff
==============================================================================
---
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/VersionMapper.java
(original)
+++
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/ant/tasks/support/VersionMapper.java
Sat Dec 13 17:56:59 2014
@@ -40,6 +40,7 @@ public class VersionMapper
private String to;
+ /** {@inheritDoc} */
public String[] mapFileName( String sourceFileName )
{
String originalFileName = new File( sourceFileName ).getName();
@@ -65,6 +66,7 @@ public class VersionMapper
/**
* Set the versions identifiers that this mapper can remove from
filenames. The separator value used is path
* separator, as used by dependencies task when setting
<code>versionsId</code> property value.
+ * @param from The string from which we set.
*/
public void setFrom( String from )
{
@@ -76,12 +78,14 @@ public class VersionMapper
/**
* By default, only filename is changed, but if this attribute is set to
<code>flatten</code>, directory is removed.
+ * @param to {@link #to}
*/
public void setTo( String to )
{
this.to = to;
}
+ /** {@inheritDoc} */
public int compare( String s1, String s2 )
{
int lengthDiff = s2.length() - s1.length();
Modified:
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/plugin/antrun/AntRunMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/plugin/antrun/AntRunMojo.java?rev=1645339&r1=1645338&r2=1645339&view=diff
==============================================================================
---
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/plugin/antrun/AntRunMojo.java
(original)
+++
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/plugin/antrun/AntRunMojo.java
Sat Dec 13 17:56:59 2014
@@ -214,9 +214,7 @@ public class AntRunMojo
@Parameter( defaultValue = "true" )
private boolean failOnError;
- /**
- * @see org.apache.maven.plugin.Mojo#execute()
- */
+ /** {@inheritDoc} */
public void execute()
throws MojoExecutionException
{
@@ -363,10 +361,10 @@ public class AntRunMojo
}
/**
- * @param artifacts
- * @param antProject
- * @return a path
- * @throws DependencyResolutionRequiredException
+ * @param artifacts {@link Artifact} collection.
+ * @param antProject {@link Project}
+ * @return {@link Path}
+ * @throws DependencyResolutionRequiredException In case of a failure.
*
*/
public Path getPathFromArtifacts( Collection<Artifact> artifacts, Project
antProject )
@@ -397,8 +395,8 @@ public class AntRunMojo
/**
* Copy properties from the Maven project to the Ant project.
*
- * @param mavenProject
- * @param antProject
+ * @param mavenProject {@link MavenProject}
+ * @param antProject {@link Project}
*/
public void copyProperties( MavenProject mavenProject, Project antProject )
{
@@ -506,7 +504,7 @@ public class AntRunMojo
* Returns a property name for a dependency artifact. The name is in the
format
* maven.dependency.groupId.artifactId[.classifier].type.path
*
- * @param artifact
+ * @param artifact {@link Artifact}
* @return property name
* @deprecated The dependency conflict ID should be used as the property
name.
*/
@@ -527,6 +525,9 @@ public class AntRunMojo
return this.project;
}
+ /**
+ * @param antProject {@link Project}
+ */
public void initMavenTasks( Project antProject )
{
getLog().debug( "Initialize Maven Ant Tasks" );
@@ -609,6 +610,11 @@ public class AntRunMojo
}
}
+ /**
+ * @param antTargetConfig {@link PlexusConfiguration}
+ * @return The target name.
+ * @throws PlexusConfigurationException in case of not existing attribute.
+ */
public String checkTargetName( PlexusConfiguration antTargetConfig )
throws PlexusConfigurationException
{
Modified:
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/plugin/antrun/AntrunXmlPlexusConfigurationWriter.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/plugin/antrun/AntrunXmlPlexusConfigurationWriter.java?rev=1645339&r1=1645338&r2=1645339&view=diff
==============================================================================
---
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/plugin/antrun/AntrunXmlPlexusConfigurationWriter.java
(original)
+++
maven/plugins/trunk/maven-antrun-plugin/src/main/java/org/apache/maven/plugin/antrun/AntrunXmlPlexusConfigurationWriter.java
Sat Dec 13 17:56:59 2014
@@ -34,6 +34,11 @@ import java.io.Writer;
public class AntrunXmlPlexusConfigurationWriter
{
+ /**
+ * @param configuration {@link PlexusConfiguration}
+ * @param writer {@link Writer}
+ * @throws IOException In case of problems.
+ */
public void write( PlexusConfiguration configuration, Writer writer )
throws IOException
{
