From 66444b15dfeb62d4a2458129ea71373bcf1313c1 Mon Sep 17 00:00:00 2001 From: Herve Boutemy Date: Fri, 28 Nov 2014 22:41:25 +0000 Subject: [PATCH] updated parent pom and fixed errors reported by Checkstyle git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1642372 13f79535-47bb-0310-9956-ffa450edef68 --- .../maven/plugins/annotations/Parameter.java | 3 ++- maven-plugin-plugin/pom.xml | 2 +- .../plugin/plugin/AbstractGeneratorMojo.java | 4 ++- .../plugin/plugin/HelpGeneratorMojo.java | 3 ++- .../maven/plugin/plugin/PluginReport.java | 7 +++-- .../AddPluginArtifactMetadataMojo.java | 3 ++- ...avaAnnotationsMojoDescriptorExtractor.java | 24 +++++++++-------- .../datamodel/ParameterAnnotationContent.java | 1 - .../DefaultMojoAnnotationsScanner.java | 8 +++--- .../scanner/MojoAnnotationsScanner.java | 4 +-- .../ant/AntMojoDescriptorExtractor.java | 17 +++++++----- .../plugin/DefaultPluginToolsRequest.java | 4 +-- .../tools/plugin/PluginToolsRequest.java | 4 +-- ...stractScriptedMojoDescriptorExtractor.java | 15 ++++++----- .../plugin/generator/GeneratorUtils.java | 2 +- .../plugin/generator/PluginHelpGenerator.java | 27 ++++++++++++------- .../extractor/java/JavaMojoAnnotation.java | 1 + .../java/JavaMojoDescriptorExtractor.java | 7 ++--- .../javadoc/MojoParameterFieldTaglet.java | 2 ++ ...equiresDependencyCollectionTypeTaglet.java | 2 ++ .../script/ant/AntMojoComponentFactory.java | 3 +++ .../maven/script/ant/AntMojoWrapper.java | 26 +++++++++++------- .../maven/script/ant/AntPropertyHelper.java | 3 ++- pom.xml | 14 +--------- 24 files changed, 109 insertions(+), 77 deletions(-) diff --git a/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java b/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java index 88c5274..ec9dbcf 100644 --- a/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java +++ b/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java @@ -53,7 +53,8 @@ public @interface Parameter String alias() default ""; /** - * Property to use to retrieve a value. Can come from -D execution, setting properties or pom properties. + * Property to use to retrieve a value. Can come from -D execution, setting properties or pom + * properties. * @return property name */ String property() default ""; diff --git a/maven-plugin-plugin/pom.xml b/maven-plugin-plugin/pom.xml index 45c107f..e793814 100644 --- a/maven-plugin-plugin/pom.xml +++ b/maven-plugin-plugin/pom.xml @@ -204,7 +204,7 @@ org.apache.rat apache-rat-plugin - + src/it/help-basic/expected-help.txt diff --git a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.java b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.java index 69f5607..73eab88 100644 --- a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.java +++ b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.java @@ -35,6 +35,7 @@ import org.apache.maven.tools.plugin.generator.Generator; import org.apache.maven.tools.plugin.generator.GeneratorException; import org.apache.maven.tools.plugin.generator.GeneratorUtils; import org.apache.maven.tools.plugin.scanner.MojoScanner; +import org.codehaus.plexus.component.repository.ComponentDependency; import org.codehaus.plexus.util.ReaderFactory; import java.io.File; @@ -231,7 +232,8 @@ public abstract class AbstractGeneratorMojo try { - pluginDescriptor.setDependencies( GeneratorUtils.toComponentDependencies( project.getRuntimeDependencies() ) ); + List deps = GeneratorUtils.toComponentDependencies( project.getRuntimeDependencies() ); + pluginDescriptor.setDependencies( deps ); PluginToolsRequest request = new DefaultPluginToolsRequest( project, pluginDescriptor ); request.setEncoding( encoding ); diff --git a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/HelpGeneratorMojo.java b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/HelpGeneratorMojo.java index 7db0d68..af63c18 100644 --- a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/HelpGeneratorMojo.java +++ b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/HelpGeneratorMojo.java @@ -38,7 +38,8 @@ import org.codehaus.plexus.velocity.VelocityComponent; * @version $Id$ * @since 2.4 */ -@Mojo( name = "helpmojo", defaultPhase = LifecyclePhase.GENERATE_SOURCES, threadSafe = true, requiresDependencyResolution = ResolutionScope.COMPILE ) +@Mojo( name = "helpmojo", defaultPhase = LifecyclePhase.GENERATE_SOURCES, threadSafe = true, + requiresDependencyResolution = ResolutionScope.COMPILE ) public class HelpGeneratorMojo extends AbstractGeneratorMojo { diff --git a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java index ba88c9a..145d90b 100644 --- a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java +++ b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java @@ -45,6 +45,7 @@ import org.apache.maven.tools.plugin.generator.GeneratorUtils; import org.apache.maven.tools.plugin.generator.PluginXdocGenerator; import org.apache.maven.tools.plugin.scanner.MojoScanner; import org.apache.maven.tools.plugin.util.PluginUtils; +import org.codehaus.plexus.component.repository.ComponentDependency; import org.codehaus.plexus.util.StringUtils; import org.codehaus.plexus.util.xml.Xpp3Dom; @@ -258,7 +259,8 @@ public class PluginReport try { - pluginDescriptor.setDependencies( GeneratorUtils.toComponentDependencies( project.getRuntimeDependencies() ) ); + List deps = GeneratorUtils.toComponentDependencies( project.getRuntimeDependencies() ); + pluginDescriptor.setDependencies( deps ); PluginToolsRequest request = new DefaultPluginToolsRequest( project, pluginDescriptor ); request.setEncoding( encoding ); @@ -668,7 +670,8 @@ public class PluginReport String jdk = requirements.getJdk(); if ( jdk == null ) { - jdk = discoverJdkRequirementFromPlugins( project.getBuild().getPluginsAsMap(), project.getProperties() ); + jdk = discoverJdkRequirementFromPlugins( project.getBuild().getPluginsAsMap(), + project.getProperties() ); } if ( jdk == null && project.getPluginManagement() != null ) { diff --git a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/metadata/AddPluginArtifactMetadataMojo.java b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/metadata/AddPluginArtifactMetadataMojo.java index f2cb014..b9d901e 100644 --- a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/metadata/AddPluginArtifactMetadataMojo.java +++ b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/metadata/AddPluginArtifactMetadataMojo.java @@ -37,7 +37,8 @@ import org.apache.maven.project.MavenProject; * artifact, for subsequent installation and deployment. * It is used: *
    - *
  1. to add the latest metadata (which is plugin-specific) for shipping alongside the plugin's artifact
    2. + *
  2. to add the latest metadata (which is plugin-specific) for shipping alongside the plugin's + * artifact
    3. *
  3. to define plugin mapping in the group
    4. *
* diff --git a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/JavaAnnotationsMojoDescriptorExtractor.java b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/JavaAnnotationsMojoDescriptorExtractor.java index 30936a8..2ac499c 100644 --- a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/JavaAnnotationsMojoDescriptorExtractor.java +++ b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/JavaAnnotationsMojoDescriptorExtractor.java @@ -283,8 +283,8 @@ public class JavaAnnotationsMojoDescriptorExtractor Map parameters = getParametersParentHierarchy( entry.getValue(), new HashMap(), mojoAnnotatedClasses ); - for ( Map.Entry parameter : new TreeMap( - parameters ).entrySet() ) + parameters = new TreeMap( parameters ); + for ( Map.Entry parameter : parameters.entrySet() ) { JavaField javaField = fieldsMap.get( parameter.getKey() ); if ( javaField == null ) @@ -309,7 +309,8 @@ public class JavaAnnotationsMojoDescriptorExtractor } // populate components - for ( Map.Entry component : entry.getValue().getComponents().entrySet() ) + Map components = entry.getValue().getComponents(); + for ( Map.Entry component : components.entrySet() ) { JavaField javaField = fieldsMap.get( component.getKey() ); if ( javaField == null ) @@ -580,9 +581,10 @@ public class JavaAnnotationsMojoDescriptorExtractor else { // not a component but a Maven object to be transformed into an expression/property: deprecated - getLogger().warn( "Deprecated @Component annotation for '" + parameter.getName() + "' field in " + - mojoAnnotatedClass.getClassName() + - ": replace with @Parameter( default-value = \"" + expression + "\", readonly = true )" ); + getLogger().warn( "Deprecated @Component annotation for '" + parameter.getName() + "' field in " + + mojoAnnotatedClass.getClassName() + + ": replace with @Parameter( default-value = \"" + expression + + "\", readonly = true )" ); parameter.setDefaultValue( expression ); parameter.setType( componentAnnotationContent.getRoleClassName() ); parameter.setRequired( true ); @@ -605,7 +607,7 @@ public class JavaAnnotationsMojoDescriptorExtractor } protected ExecuteAnnotationContent findExecuteInParentHierarchy( MojoAnnotatedClass mojoAnnotatedClass, - Map mojoAnnotatedClasses ) + Map mojoAnnotatedClasses ) { if ( mojoAnnotatedClass.getExecute() != null ) { @@ -648,8 +650,8 @@ public class JavaAnnotationsMojoDescriptorExtractor } protected List getParametersParent( MojoAnnotatedClass mojoAnnotatedClass, - List parameterAnnotationContents, - Map mojoAnnotatedClasses ) + List parameterAnnotationContents, + Map mojoAnnotatedClasses ) { parameterAnnotationContents.addAll( mojoAnnotatedClass.getParameters().values() ); String parentClassName = mojoAnnotatedClass.getParentClassName(); @@ -687,8 +689,8 @@ public class JavaAnnotationsMojoDescriptorExtractor } protected List getComponentParent( MojoAnnotatedClass mojoAnnotatedClass, - List componentAnnotationContents, - Map mojoAnnotatedClasses ) + List componentAnnotationContents, + Map mojoAnnotatedClasses ) { componentAnnotationContents.addAll( mojoAnnotatedClass.getComponents().values() ); String parentClassName = mojoAnnotatedClass.getParentClassName(); diff --git a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/datamodel/ParameterAnnotationContent.java b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/datamodel/ParameterAnnotationContent.java index 10be10c..a40c12e 100644 --- a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/datamodel/ParameterAnnotationContent.java +++ b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/datamodel/ParameterAnnotationContent.java @@ -20,7 +20,6 @@ package org.apache.maven.tools.plugin.annotations.datamodel; */ import org.apache.maven.plugins.annotations.Parameter; -import org.codehaus.plexus.util.StringUtils; import java.lang.annotation.Annotation; diff --git a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/scanner/DefaultMojoAnnotationsScanner.java b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/scanner/DefaultMojoAnnotationsScanner.java index 1be6561..731b824 100644 --- a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/scanner/DefaultMojoAnnotationsScanner.java +++ b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/scanner/DefaultMojoAnnotationsScanner.java @@ -264,7 +264,8 @@ public class DefaultMojoAnnotationsScanner new ParameterAnnotationContent( mojoFieldVisitor.getFieldName(), mojoFieldVisitor.getClassName() ); if ( mojoFieldVisitor.getMojoAnnotationVisitor() != null ) { - populateAnnotationContent( parameterAnnotationContent, mojoFieldVisitor.getMojoAnnotationVisitor() ); + populateAnnotationContent( parameterAnnotationContent, + mojoFieldVisitor.getMojoAnnotationVisitor() ); } mojoAnnotatedClass.getParameters().put( parameterAnnotationContent.getFieldName(), @@ -278,9 +279,10 @@ public class DefaultMojoAnnotationsScanner ComponentAnnotationContent componentAnnotationContent = new ComponentAnnotationContent( mojoFieldVisitor.getFieldName() ); - if ( mojoFieldVisitor.getMojoAnnotationVisitor() != null ) + MojoAnnotationVisitor annotationVisitor = mojoFieldVisitor.getMojoAnnotationVisitor(); + if ( annotationVisitor != null ) { - for ( Map.Entry entry : mojoFieldVisitor.getMojoAnnotationVisitor().getAnnotationValues().entrySet() ) + for ( Map.Entry entry : annotationVisitor.getAnnotationValues().entrySet() ) { String methodName = entry.getKey(); if ( StringUtils.equals( "role", methodName ) ) diff --git a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/scanner/MojoAnnotationsScanner.java b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/scanner/MojoAnnotationsScanner.java index 6ab8b60..4808d28 100644 --- a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/scanner/MojoAnnotationsScanner.java +++ b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/annotations/scanner/MojoAnnotationsScanner.java @@ -37,9 +37,9 @@ public interface MojoAnnotationsScanner { String ROLE = MojoAnnotationsScanner.class.getName(); - final List CLASS_LEVEL_ANNOTATIONS = Arrays.asList( Mojo.class.getName(), Execute.class.getName() ); + List CLASS_LEVEL_ANNOTATIONS = Arrays.asList( Mojo.class.getName(), Execute.class.getName() ); - final List FIELD_LEVEL_ANNOTATIONS = Arrays.asList( Parameter.class.getName(), Component.class.getName() ); + List FIELD_LEVEL_ANNOTATIONS = Arrays.asList( Parameter.class.getName(), Component.class.getName() ); /** * Scan classes for mojo annotations. diff --git a/maven-plugin-tools-ant/src/main/java/org/apache/maven/tools/plugin/extractor/ant/AntMojoDescriptorExtractor.java b/maven-plugin-tools-ant/src/main/java/org/apache/maven/tools/plugin/extractor/ant/AntMojoDescriptorExtractor.java index 79f479d..711fc01 100644 --- a/maven-plugin-tools-ant/src/main/java/org/apache/maven/tools/plugin/extractor/ant/AntMojoDescriptorExtractor.java +++ b/maven-plugin-tools-ant/src/main/java/org/apache/maven/tools/plugin/extractor/ant/AntMojoDescriptorExtractor.java @@ -58,8 +58,9 @@ public class AntMojoDescriptorExtractor private static final String SCRIPT_FILE_EXTENSION = ".build.xml"; /** {@inheritDoc} */ - protected List extractMojoDescriptorsFromMetadata( Map> metadataFilesKeyedByBasedir, - PluginToolsRequest request ) + protected List extractMojoDescriptorsFromMetadata( + Map> metadataFilesKeyedByBasedir, + PluginToolsRequest request ) throws ExtractionException, InvalidPluginDescriptorException { List descriptors = new ArrayList(); @@ -136,7 +137,8 @@ public class AntMojoDescriptorExtractor param.setName( "project" ); param.setDefaultValue( "${project}" ); param.setType( MavenProject.class.getName() ); - param.setDescription( "The current MavenProject instance, which contains classpath elements." ); + param.setDescription( "The current MavenProject instance, which contains classpath " + + "elements." ); param.setEditable( false ); param.setRequired( true ); @@ -149,7 +151,8 @@ public class AntMojoDescriptorExtractor param.setName( "session" ); param.setDefaultValue( "${session}" ); param.setType( "org.apache.maven.execution.MavenSession" ); - param.setDescription( "The current MavenSession instance, which is used for plugin-style expression resolution." ); + param.setDescription( "The current MavenSession instance, which is used for " + + "plugin-style expression resolution." ); param.setEditable( false ); param.setRequired( true ); @@ -162,7 +165,8 @@ public class AntMojoDescriptorExtractor param.setName( "mojoExecution" ); param.setDefaultValue( "${mojoExecution}" ); param.setType( "org.apache.maven.plugin.MojoExecution" ); - param.setDescription( "The current Maven MojoExecution instance, which contains information about the mojo currently executing." ); + param.setDescription( "The current Maven MojoExecution instance, which contains " + + "information about the mojo currently executing." ); param.setEditable( false ); param.setRequired( true ); @@ -201,7 +205,8 @@ public class AntMojoDescriptorExtractor else { implementation = - relativePath + dImpl.substring( PluginMetadataParser.IMPL_BASE_PLACEHOLDER.length() ); + relativePath + + dImpl.substring( PluginMetadataParser.IMPL_BASE_PLACEHOLDER.length() ); } } diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/DefaultPluginToolsRequest.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/DefaultPluginToolsRequest.java index 9c70400..9c5dd60 100644 --- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/DefaultPluginToolsRequest.java +++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/DefaultPluginToolsRequest.java @@ -21,7 +21,6 @@ package org.apache.maven.tools.plugin; import org.apache.maven.artifact.Artifact; import org.apache.maven.artifact.repository.ArtifactRepository; -import org.apache.maven.plugin.descriptor.MojoDescriptor; import org.apache.maven.plugin.descriptor.PluginDescriptor; import org.apache.maven.project.MavenProject; import org.codehaus.plexus.util.ReaderFactory; @@ -33,7 +32,8 @@ import java.util.Set; /** * Default implementation of {@link PluginToolsRequest}, which is used to pass parameters to components used to extract - * {@link MojoDescriptor} instances from different types of metadata for a given plugin. + * {@link org.apache.maven.plugin.descriptor.MojoDescriptor MojoDescriptor} instances from different types of metadata + * for a given plugin. * * @author jdcasey * @since 2.5 diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/PluginToolsRequest.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/PluginToolsRequest.java index 03fe386..e2a38b2 100644 --- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/PluginToolsRequest.java +++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/PluginToolsRequest.java @@ -21,7 +21,6 @@ package org.apache.maven.tools.plugin; import org.apache.maven.artifact.Artifact; import org.apache.maven.artifact.repository.ArtifactRepository; -import org.apache.maven.plugin.descriptor.MojoDescriptor; import org.apache.maven.plugin.descriptor.PluginDescriptor; import org.apache.maven.project.MavenProject; @@ -29,7 +28,8 @@ import java.util.List; import java.util.Set; /** - * Request that encapsulates all information relevant to the process of extracting {@link MojoDescriptor} + * Request that encapsulates all information relevant to the process of extracting + * {@link org.apache.maven.plugin.descriptor.MojoDescriptor MojoDescriptor} * instances from metadata for a certain type of mojo. * * @author jdcasey diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java index 2f91ac4..01cbba0 100644 --- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java +++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java @@ -83,7 +83,8 @@ public abstract class AbstractScriptedMojoDescriptorExtractor * @param outputDirectory not null * @throws ExtractionException if any */ - protected void copyScriptsToOutputDirectory( Map> scriptFilesKeyedByBasedir, String outputDirectory, PluginToolsRequest request ) + protected void copyScriptsToOutputDirectory( Map> scriptFilesKeyedByBasedir, + String outputDirectory, PluginToolsRequest request ) throws ExtractionException { File outputDir = new File( outputDirectory ); @@ -134,7 +135,8 @@ public abstract class AbstractScriptedMojoDescriptorExtractor * @param scriptFileExtension not null * @return map with subdirs paths as key */ - protected Map> gatherFilesByBasedir( File basedir, List directories, String scriptFileExtension, PluginToolsRequest request ) + protected Map> gatherFilesByBasedir( File basedir, List directories, + String scriptFileExtension, PluginToolsRequest request ) { Map> sourcesByBasedir = new TreeMap>(); @@ -182,14 +184,14 @@ public abstract class AbstractScriptedMojoDescriptorExtractor /** * Should be implemented in the sub classes. * - * @param metadataFilesKeyedByBasedir could be null + * @param metadataFilesByBasedir could be null * @param request The plugin request, never null. * @return always null * @throws ExtractionException if any * @throws InvalidPluginDescriptorException if any */ - protected List extractMojoDescriptorsFromMetadata( Map> metadataFilesKeyedByBasedir, - PluginToolsRequest request ) + protected List extractMojoDescriptorsFromMetadata( Map> metadataFilesByBasedir, + PluginToolsRequest request ) throws ExtractionException, InvalidPluginDescriptorException { return null; @@ -214,7 +216,8 @@ public abstract class AbstractScriptedMojoDescriptorExtractor * @throws ExtractionException if any * @throws InvalidPluginDescriptorException if any */ - protected List extractMojoDescriptors( Map> scriptFilesKeyedByBasedir, PluginToolsRequest request ) + protected List extractMojoDescriptors( Map> scriptFilesKeyedByBasedir, + PluginToolsRequest request ) throws ExtractionException, InvalidPluginDescriptorException { return null; diff --git a/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/GeneratorUtils.java b/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/GeneratorUtils.java index 6799a8a..2b5ef3b 100644 --- a/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/GeneratorUtils.java +++ b/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/GeneratorUtils.java @@ -359,7 +359,7 @@ public final class GeneratorUtils */ class Counter { - public int value; + int value; } /** diff --git a/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java b/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java index 3e32bc5..23c3ed9 100644 --- a/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java +++ b/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java @@ -56,13 +56,13 @@ import java.util.Properties; /** * Generates an HelpMojo class from help-class-source.vm template. - * The generated mojo reads help content from META-INF/maven/${groupId}/${artifactId}/plugin-help.xml resource, - * which is generated by this {@link PluginDescriptorGenerator}. + * The generated mojo reads help content from META-INF/maven/${groupId}/${artifactId}/plugin-help.xml + * resource, which is generated by this {@link PluginDescriptorGenerator}. *

Notice that the help mojo source needs to be generated before compilation, but when Java 5 annotations are used, * plugin descriptor content is available only after compilation (detecting annotations in .class files): * help mojo source can be generated with empty package only (and no plugin descriptor available yet), then needs - * to be updated after compilation - through {@link #rewriteHelpMojo(PluginToolsRequest, Log)} which is called from plugin - * descriptor XML generation.

+ * to be updated after compilation - through {@link #rewriteHelpMojo(PluginToolsRequest, Log)} which is called from + * plugin descriptor XML generation.

* * @author Vincent Siveton * @version $Id$ @@ -138,7 +138,9 @@ public class PluginHelpGenerator writeHelpPropertiesFile( request, destinationDirectory ); - useAnnotations = request.getProject().getArtifactMap().containsKey( "org.apache.maven.plugin-tools:maven-plugin-annotations" ); + useAnnotations = + request.getProject().getArtifactMap().containsKey( + "org.apache.maven.plugin-tools:maven-plugin-annotations" ); try { @@ -147,7 +149,8 @@ public class PluginHelpGenerator File helpClass = new File( destinationDirectory, sourcePath ); helpClass.getParentFile().mkdirs(); - String helpClassSources = getHelpClassSources( getPluginHelpPath( request.getProject() ), pluginDescriptor ); + String helpClassSources = getHelpClassSources( getPluginHelpPath( request.getProject() ), + pluginDescriptor ); FileUtils.fileWrite( helpClass, request.getEncoding(), helpClassSources ); } @@ -201,7 +204,8 @@ public class PluginHelpGenerator InputStreamReader isReader = null; try { - isReader = new InputStreamReader( is, "UTF-8" ); // plugin-tools sources are UTF-8 (and even ASCII in this case) + isReader = new InputStreamReader( is, "UTF-8" ); // plugin-tools sources are UTF-8 (and even ASCII in this + // case) velocityComponent.getEngine().evaluate( context, stringWriter, "", isReader ); } catch ( UnsupportedEncodingException e ) @@ -229,7 +233,8 @@ public class PluginHelpGenerator helpPackageName = GeneratorUtils.discoverPackageName( pluginDescriptor ); } - return StringUtils.isEmpty( helpPackageName ) ? HELP_MOJO_CLASS_NAME : helpPackageName + '.' + HELP_MOJO_CLASS_NAME; + return StringUtils.isEmpty( helpPackageName ) ? HELP_MOJO_CLASS_NAME : helpPackageName + '.' + + HELP_MOJO_CLASS_NAME; } /** @@ -330,7 +335,8 @@ public class PluginHelpGenerator } } - private static String rewriteHelpClassToMojoPackage( PluginToolsRequest request, File destinationDirectory, Log log ) + private static String rewriteHelpClassToMojoPackage( PluginToolsRequest request, File destinationDirectory, + Log log ) throws GeneratorException { String destinationPackage = GeneratorUtils.discoverPackageName( request.getPluginDescriptor() ); @@ -356,7 +362,8 @@ public class PluginHelpGenerator } else { - File helpSourceFileNew = new File( destinationDirectory, packageAsDirectory + '/' + HELP_MOJO_CLASS_NAME + ".java" ); + File helpSourceFileNew = + new File( destinationDirectory, packageAsDirectory + '/' + HELP_MOJO_CLASS_NAME + ".java" ); if ( !helpSourceFileNew.getParentFile().exists() ) { helpSourceFileNew.getParentFile().mkdirs(); diff --git a/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/java/JavaMojoAnnotation.java b/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/java/JavaMojoAnnotation.java index 01e03fc..e26d563 100644 --- a/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/java/JavaMojoAnnotation.java +++ b/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/java/JavaMojoAnnotation.java @@ -26,6 +26,7 @@ package org.apache.maven.tools.plugin.extractor.java; * @version $Id$ * @since 2.4 */ +@SuppressWarnings( "checkstyle:interfaceistype" ) public interface JavaMojoAnnotation { // ---------------------------------------------------------------------- diff --git a/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/java/JavaMojoDescriptorExtractor.java b/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/java/JavaMojoDescriptorExtractor.java index 7d5e7f8..9bd41a2 100644 --- a/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/java/JavaMojoDescriptorExtractor.java +++ b/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/java/JavaMojoDescriptorExtractor.java @@ -540,9 +540,10 @@ public class JavaMojoDescriptorExtractor else { // not a component but a Maven object to be transformed into an expression/property - getLogger().warn( - "Deprecated @component Javadoc tag for '" + pd.getName() + "' field in " + javaClass.getFullyQualifiedName() + - ": replace with @Parameter( defaultValue = \"" + role + "\", readonly = true )" ); + getLogger().warn( "Deprecated @component Javadoc tag for '" + pd.getName() + "' field in " + + javaClass.getFullyQualifiedName() + + ": replace with @Parameter( defaultValue = \"" + role + + "\", readonly = true )" ); pd.setDefaultValue( role ); pd.setRequired( true ); } diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoParameterFieldTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoParameterFieldTaglet.java index 9d0932f..91fcb33 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoParameterFieldTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoParameterFieldTaglet.java @@ -25,6 +25,7 @@ import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation; import com.sun.tools.doclets.Taglet; +// CHECKSTYLE_OFF: LineLength /** * The @parameter tag is used to define a Mojo parameter and has annotation parameter. *
@@ -52,6 +53,7 @@ import com.sun.tools.doclets.Taglet; * @author Vincent Siveton * @version $Id$ */ +//CHECKSTYLE_ON: LineLength public class MojoParameterFieldTaglet extends AbstractMojoFieldTaglet { diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresDependencyCollectionTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresDependencyCollectionTypeTaglet.java index f0bde8e..bc221c2 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresDependencyCollectionTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresDependencyCollectionTypeTaglet.java @@ -24,6 +24,7 @@ import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation; import java.util.Map; +//CHECKSTYLE_OFF: LineLength /** * The @requiresDependencyCollection tag is used to specify the required dependencies in the specified scope * and has parameter. @@ -52,6 +53,7 @@ import java.util.Map; * @author Kristian Rosenvold * @version $Id$ */ +//CHECKSTYLE_ON: LineLength public class MojoRequiresDependencyCollectionTypeTaglet extends AbstractMojoTypeTaglet { diff --git a/maven-script/maven-script-ant/src/main/java/org/apache/maven/script/ant/AntMojoComponentFactory.java b/maven-script/maven-script-ant/src/main/java/org/apache/maven/script/ant/AntMojoComponentFactory.java index 159bc16..6c5a916 100644 --- a/maven-script/maven-script-ant/src/main/java/org/apache/maven/script/ant/AntMojoComponentFactory.java +++ b/maven-script/maven-script-ant/src/main/java/org/apache/maven/script/ant/AntMojoComponentFactory.java @@ -26,6 +26,9 @@ import org.codehaus.plexus.component.factory.ant.AntComponentFactory; import org.codehaus.plexus.component.factory.ant.AntScriptInvoker; import org.codehaus.plexus.component.repository.ComponentDescriptor; +/** + * + */ public class AntMojoComponentFactory extends AntComponentFactory { diff --git a/maven-script/maven-script-ant/src/main/java/org/apache/maven/script/ant/AntMojoWrapper.java b/maven-script/maven-script-ant/src/main/java/org/apache/maven/script/ant/AntMojoWrapper.java index 5de86f6..9d02206 100644 --- a/maven-script/maven-script-ant/src/main/java/org/apache/maven/script/ant/AntMojoWrapper.java +++ b/maven-script/maven-script-ant/src/main/java/org/apache/maven/script/ant/AntMojoWrapper.java @@ -53,6 +53,9 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +/** + * + */ public class AntMojoWrapper extends AbstractMojo implements ContextEnabled, MapOrientedComponent, LogEnabled @@ -131,7 +134,8 @@ public class AntMojoWrapper buffer.append( "\n- " ).append( part ); } - buffer.append( "\n\nMaven project, session, mojo-execution, or path-translation parameter information is " ); + buffer.append( "\n\nMaven project, session, mojo-execution, or path-translation parameter " + + "information is " ); buffer.append( "\nmissing from this mojo's plugin descriptor." ); buffer.append( "\n\nPerhaps this Ant-based mojo depends on maven-script-ant < 2.1.0, " ); buffer.append( "or used maven-plugin-tools-ant < 2.2 during release?\n\n" ); @@ -218,8 +222,8 @@ public class AntMojoWrapper if ( mavenProject != null && session != null && pathTranslator != null ) { ExpressionEvaluator exprEvaluator = - new PluginParameterExpressionEvaluator( session, mojoExecution, pathTranslator, logger, mavenProject, - mavenProject.getProperties() ); + new PluginParameterExpressionEvaluator( session, mojoExecution, pathTranslator, logger, + mavenProject, mavenProject.getProperties() ); PropertyHelper propertyHelper = PropertyHelper.getPropertyHelper( antProject ); propertyHelper.setNext( new AntPropertyHelper( exprEvaluator, mavenProject.getArtifacts(), getLog() ) ); @@ -238,7 +242,8 @@ public class AntMojoWrapper // Compile classpath Path p = new Path( antProject ); - p.setPath( StringUtils.join( mavenProject.getCompileClasspathElements().iterator(), File.pathSeparator ) ); + p.setPath( StringUtils.join( mavenProject.getCompileClasspathElements().iterator(), + File.pathSeparator ) ); /* maven.dependency.classpath it's deprecated as it's equal to maven.compile.classpath */ references.put( "maven.dependency.classpath", p ); @@ -250,7 +255,8 @@ public class AntMojoWrapper // Runtime classpath p = new Path( antProject ); - p.setPath( StringUtils.join( mavenProject.getRuntimeClasspathElements().iterator(), File.pathSeparator ) ); + p.setPath( StringUtils.join( mavenProject.getRuntimeClasspathElements().iterator(), + File.pathSeparator ) ); references.put( "maven.runtime.classpath", p ); antProject.addReference( "maven.runtime.classpath", p ); @@ -258,7 +264,8 @@ public class AntMojoWrapper // Test classpath p = new Path( antProject ); - p.setPath( StringUtils.join( mavenProject.getTestClasspathElements().iterator(), File.pathSeparator ) ); + p.setPath( StringUtils.join( mavenProject.getTestClasspathElements().iterator(), + File.pathSeparator ) ); references.put( "maven.test.classpath", p ); antProject.addReference( "maven.test.classpath", p ); @@ -272,8 +279,9 @@ public class AntMojoWrapper if ( mojoExecution != null ) { // Plugin dependency classpath - - Path p = getPathFromArtifacts( mojoExecution.getMojoDescriptor().getPluginDescriptor().getArtifacts(), antProject ); + Path p = + getPathFromArtifacts( mojoExecution.getMojoDescriptor().getPluginDescriptor().getArtifacts(), + antProject ); references.put( "maven.plugin.classpath", p ); antProject.addReference( "maven.plugin.classpath", p ); @@ -285,7 +293,7 @@ public class AntMojoWrapper } catch ( DependencyResolutionRequiredException e ) { - throw new MojoExecutionException( "Error creating classpath references for Ant-based plugin scripts.", e ); + throw new MojoExecutionException( "Error creating classpath references for Ant-based plugin scripts.", e ); } } diff --git a/maven-script/maven-script-ant/src/main/java/org/apache/maven/script/ant/AntPropertyHelper.java b/maven-script/maven-script-ant/src/main/java/org/apache/maven/script/ant/AntPropertyHelper.java index 3a81fc2..6722371 100644 --- a/maven-script/maven-script-ant/src/main/java/org/apache/maven/script/ant/AntPropertyHelper.java +++ b/maven-script/maven-script-ant/src/main/java/org/apache/maven/script/ant/AntPropertyHelper.java @@ -59,7 +59,8 @@ public class AntPropertyHelper } /** - * @deprecated use {@link #AntPropertyHelper(ExpressionEvaluator, Set, Log)} to resolve maven.dependency.* properties + * @deprecated use {@link #AntPropertyHelper(ExpressionEvaluator, Set, Log)} to resolve maven.dependency.* + * properties * @param exprEvaluator * @param l */ diff --git a/pom.xml b/pom.xml index 7f3a597..b7c95f7 100644 --- a/pom.xml +++ b/pom.xml @@ -23,7 +23,7 @@ maven-parent org.apache.maven - 24 + 26 ../pom/maven/pom.xml @@ -269,18 +269,6 @@ - - org.apache.maven.plugins - maven-site-plugin - - scm:svn:https://svn.apache.org/repos/infra/websites/production/maven/content/${maven.site.path} - - - - org.apache.maven.plugins - maven-scm-publish-plugin - 1.1 - org.apache.maven.plugins maven-release-plugin