You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sj...@apache.org on 2022/10/15 13:16:15 UTC
[maven-plugin-tools] 01/01: [MPLUGIN-419] Allow @Parameter on setters methods
This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch MPLUGIN-419
in repository https://gitbox.apache.org/repos/asf/maven-plugin-tools.git
commit c2c07f9bf62ecdbdc2e95146bc48215ee411bf60
Author: Slawomir Jaranowski <s....@gmail.com>
AuthorDate: Sat Oct 15 15:15:55 2022 +0200
[MPLUGIN-419] Allow @Parameter on setters methods
- new implementation
- remove some of unused or unneeded methods
---
.../maven/plugins/annotations/Parameter.java | 2 +-
maven-plugin-plugin/pom.xml | 1 +
.../verify.groovy | 24 +++-
.../src/site/apt/examples/using-annotations.apt.vm | 8 +-
.../JavaAnnotationsMojoDescriptorExtractor.java | 49 +++++---
.../scanner/DefaultMojoAnnotationsScanner.java | 15 ++-
.../scanner/MojoAnnotationsScanner.java | 3 +
.../scanner/visitors/MojoAnnotationVisitor.java | 23 +---
.../scanner/visitors/MojoClassVisitor.java | 124 ++++++++-------------
.../scanner/visitors/MojoFieldVisitor.java | 31 ++----
...ojoFieldVisitor.java => MojoMethodVisitor.java} | 51 +++------
.../scanner/visitors/MojoParameterVisitor.java | 36 ++++++
.../src/site/apt/index.apt | 9 ++
.../plugin/extractor/annotations/FooMojo.java | 29 +++++
.../annotations/TestAnnotationsReader.java | 15 ++-
15 files changed, 239 insertions(+), 181 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 0e643d6b..f9eda41e 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
@@ -40,7 +40,7 @@ import java.lang.annotation.Target;
*/
@Documented
@Retention( RetentionPolicy.CLASS )
-@Target( { ElementType.FIELD } )
+@Target( { ElementType.FIELD, ElementType.METHOD } )
@Inherited
public @interface Parameter
{
diff --git a/maven-plugin-plugin/pom.xml b/maven-plugin-plugin/pom.xml
index 5b16dbe0..e280d4b5 100644
--- a/maven-plugin-plugin/pom.xml
+++ b/maven-plugin-plugin/pom.xml
@@ -310,6 +310,7 @@
<localRepositoryPath>${project.build.directory}/local-repo</localRepositoryPath>
<settingsFile>src/it/settings.xml</settingsFile>
<streamLogsOnFailures>true</streamLogsOnFailures>
+ <showErrors>true</showErrors>
<filterProperties>
<sitePluginVersion>3.12.1</sitePluginVersion>
<projectInfoReportsPlugin>3.4.1</projectInfoReportsPlugin>
diff --git a/maven-plugin-plugin/src/it/annotation-with-inheritance-from-deps/verify.groovy b/maven-plugin-plugin/src/it/annotation-with-inheritance-from-deps/verify.groovy
index b941b803..47906867 100644
--- a/maven-plugin-plugin/src/it/annotation-with-inheritance-from-deps/verify.groovy
+++ b/maven-plugin-plugin/src/it/annotation-with-inheritance-from-deps/verify.groovy
@@ -61,7 +61,7 @@ assert mojo.requirements.requirement[1].role.text() == 'org.apache.maven.project
assert mojo.requirements.requirement[1].'role-hint'.text() == ''
assert mojo.requirements.requirement[1].'field-name'.text() == 'projectHelper'
-assert mojo.parameters.parameter.size() == 4
+assert mojo.parameters.parameter.size() == 6
def parameter = mojo.parameters.parameter.findAll{ it.name.text() == "aliasedParam"}[0]
@@ -107,4 +107,26 @@ assert parameter.required.text() == 'false'
assert parameter.editable.text() == 'true'
assert parameter.description.text() == 'Interface type as parameter.'
+parameter = mojo.parameters.parameter.findAll{ it.name.text() == "paramFromSetter"}[0]
+
+assert parameter.name.text() == 'paramFromSetter'
+assert parameter.alias.isEmpty()
+assert parameter.type.text() == 'java.lang.String'
+assert parameter.implementation.isEmpty()
+assert parameter.deprecated.isEmpty()
+assert parameter.required.text() == 'false'
+assert parameter.editable.text() == 'true'
+assert parameter.description.text() == 'setter as parameter.'
+
+parameter = mojo.parameters.parameter.findAll{ it.name.text() == "paramFromSetterDeprecated"}[0]
+
+assert parameter.name.text() == 'paramFromSetterDeprecated'
+assert parameter.alias.isEmpty()
+assert parameter.type.text() == 'java.util.List'
+assert parameter.implementation.isEmpty()
+assert parameter.deprecated.text() == 'reason of deprecation'
+assert parameter.required.text() == 'false'
+assert parameter.editable.text() == 'true'
+assert parameter.description.text() == 'deprecated setter as parameter.'
+
return true;
diff --git a/maven-plugin-plugin/src/site/apt/examples/using-annotations.apt.vm b/maven-plugin-plugin/src/site/apt/examples/using-annotations.apt.vm
index d6a0df61..3a118ec5 100644
--- a/maven-plugin-plugin/src/site/apt/examples/using-annotations.apt.vm
+++ b/maven-plugin-plugin/src/site/apt/examples/using-annotations.apt.vm
@@ -41,7 +41,7 @@ Using Plugin Tools Java Annotations
Information for plugin descriptor generation is specified using 4 annotations:
- * 2 class-level annotations:
+ * 2 class level annotations:
* <<<...@Mojo>>>: This annotation will mark your class as a Mojo,
@@ -49,10 +49,14 @@ Using Plugin Tools Java Annotations
[]
- * 2 field-level annotations:
+ * 1 filed or method level annotations:
* <<<...@Parameter>>>: Used to configure your Mojo parameters,
+ []
+
+ * 1 field level annotations:
+
* <<<...@Component>>>: Used to configure injection of Plexus components or Maven context components.
[]
diff --git a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/JavaAnnotationsMojoDescriptorExtractor.java b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/JavaAnnotationsMojoDescriptorExtractor.java
index 422d58c6..0f5b778f 100644
--- a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/JavaAnnotationsMojoDescriptorExtractor.java
+++ b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/JavaAnnotationsMojoDescriptorExtractor.java
@@ -40,6 +40,8 @@ import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;
+import com.thoughtworks.qdox.model.JavaAnnotatedElement;
+import com.thoughtworks.qdox.model.JavaMethod;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.resolver.ArtifactResolutionRequest;
import org.apache.maven.artifact.resolver.ArtifactResolutionResult;
@@ -303,7 +305,7 @@ public class JavaAnnotationsMojoDescriptorExtractor
}
}
- Map<String, JavaField> fieldsMap = extractFieldParameterTags( javaClass, javaClassesMap );
+ Map<String, JavaAnnotatedElement> elementMap = extractParameterTags( javaClass, javaClassesMap );
// populate parameters
Map<String, ParameterAnnotationContent> parameters =
@@ -311,22 +313,22 @@ public class JavaAnnotationsMojoDescriptorExtractor
parameters = new TreeMap<>( parameters );
for ( Map.Entry<String, ParameterAnnotationContent> parameter : parameters.entrySet() )
{
- JavaField javaField = fieldsMap.get( parameter.getKey() );
- if ( javaField == null )
+ JavaAnnotatedElement element = elementMap.get( parameter.getKey() );
+ if ( element == null )
{
continue;
}
ParameterAnnotationContent parameterAnnotationContent = parameter.getValue();
- parameterAnnotationContent.setDescription( javaField.getComment() );
+ parameterAnnotationContent.setDescription( element.getComment() );
- DocletTag deprecated = javaField.getTagByName( "deprecated" );
+ DocletTag deprecated = element.getTagByName( "deprecated" );
if ( deprecated != null )
{
parameterAnnotationContent.setDeprecated( deprecated.getValue() );
}
- DocletTag since = javaField.getTagByName( "since" );
+ DocletTag since = element.getTagByName( "since" );
if ( since != null )
{
parameterAnnotationContent.setSince( since.getValue() );
@@ -337,7 +339,7 @@ public class JavaAnnotationsMojoDescriptorExtractor
Map<String, ComponentAnnotationContent> components = entry.getValue().getComponents();
for ( Map.Entry<String, ComponentAnnotationContent> component : components.entrySet() )
{
- JavaField javaField = fieldsMap.get( component.getKey() );
+ JavaAnnotatedElement javaField = elementMap.get( component.getKey() );
if ( javaField == null )
{
continue;
@@ -395,16 +397,17 @@ public class JavaAnnotationsMojoDescriptorExtractor
/**
* extract fields that are either parameters or components.
+ * also extract methods that are parameters
*
* @param javaClass not null
* @return map with Mojo parameters names as keys
*/
- private Map<String, JavaField> extractFieldParameterTags( JavaClass javaClass,
- Map<String, JavaClass> javaClassesMap )
+ private Map<String, JavaAnnotatedElement> extractParameterTags( JavaClass javaClass,
+ Map<String, JavaClass> javaClassesMap )
{
try
{
- Map<String, JavaField> rawParams = new TreeMap<>();
+ Map<String, JavaAnnotatedElement> rawParams = new TreeMap<>();
// we have to add the parent fields first, so that they will be overwritten by the local fields if
// that actually happens...
@@ -412,15 +415,15 @@ public class JavaAnnotationsMojoDescriptorExtractor
if ( superClass != null )
{
- if ( superClass.getFields().size() > 0 )
+ if ( !superClass.getFields().isEmpty() || !superClass.getMethods().isEmpty() )
{
- rawParams = extractFieldParameterTags( superClass, javaClassesMap );
+ rawParams = extractParameterTags( superClass, javaClassesMap );
}
// maybe sources comes from scan of sources artifact
superClass = javaClassesMap.get( superClass.getFullyQualifiedName() );
- if ( superClass != null )
+ if ( superClass != null && ( !superClass.getFields().isEmpty() || !superClass.getMethods().isEmpty() ) )
{
- rawParams = extractFieldParameterTags( superClass, javaClassesMap );
+ rawParams = extractParameterTags( superClass, javaClassesMap );
}
}
else
@@ -434,6 +437,15 @@ public class JavaAnnotationsMojoDescriptorExtractor
rawParams.put( field.getName(), field );
}
+ for ( JavaMethod method : javaClass.getMethods() )
+ {
+ if ( isPublicSetterMethod( method ) )
+ {
+ rawParams.put(
+ StringUtils.lowercaseFirstLetter( method.getName().substring( 3 ) ), method );
+ }
+ }
+
return rawParams;
}
catch ( NoClassDefFoundError e )
@@ -443,6 +455,15 @@ public class JavaAnnotationsMojoDescriptorExtractor
}
}
+ private boolean isPublicSetterMethod( JavaMethod method )
+ {
+ return method.isPublic()
+ && method.getName().startsWith( "set" )
+ && method.getName().length() > 3
+ && "void".equals( method.getReturnType().getValue() )
+ && method.getParameters().size() == 1;
+ }
+
protected Map<String, JavaClass> discoverClasses( final PluginToolsRequest request )
{
return discoverClasses( request.getEncoding(), request.getProject() );
diff --git a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/DefaultMojoAnnotationsScanner.java b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/DefaultMojoAnnotationsScanner.java
index 0407b8ea..2b441751 100644
--- a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/DefaultMojoAnnotationsScanner.java
+++ b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/DefaultMojoAnnotationsScanner.java
@@ -35,6 +35,7 @@ import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAn
import org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor;
import org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor;
import org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor;
+import org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoParameterVisitor;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import org.codehaus.plexus.util.DirectoryScanner;
import org.codehaus.plexus.util.StringUtils;
@@ -56,6 +57,8 @@ import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
/**
+ * Mojo scanner with java annotations.
+ *
* @author Olivier Lamy
* @since 3.0
*/
@@ -206,7 +209,7 @@ public class DefaultMojoAnnotationsScanner
Artifact artifact, boolean excludeMojo, String source, String file )
throws IOException, ExtractionException
{
- MojoClassVisitor mojoClassVisitor = new MojoClassVisitor( getLogger() );
+ MojoClassVisitor mojoClassVisitor = new MojoClassVisitor( );
try
{
@@ -295,13 +298,13 @@ public class DefaultMojoAnnotationsScanner
}
// @Parameter annotations
- List<MojoFieldVisitor> mojoFieldVisitors = mojoClassVisitor.findFieldWithAnnotation( Parameter.class );
- for ( MojoFieldVisitor mojoFieldVisitor : mojoFieldVisitors )
+ List<MojoParameterVisitor> mojoParameterVisitors = mojoClassVisitor.findParameterVisitors();
+ for ( MojoParameterVisitor parameterVisitor : mojoParameterVisitors )
{
ParameterAnnotationContent parameterAnnotationContent =
- new ParameterAnnotationContent( mojoFieldVisitor.getFieldName(), mojoFieldVisitor.getClassName() );
+ new ParameterAnnotationContent( parameterVisitor.getFieldName(), parameterVisitor.getClassName() );
- Map<String, MojoAnnotationVisitor> annotationVisitorMap = mojoFieldVisitor.getAnnotationVisitorMap();
+ Map<String, MojoAnnotationVisitor> annotationVisitorMap = parameterVisitor.getAnnotationVisitorMap();
MojoAnnotationVisitor fieldAnnotationVisitor = annotationVisitorMap.get( Parameter.class.getName() );
populateAnnotationContent( parameterAnnotationContent, fieldAnnotationVisitor );
@@ -316,7 +319,7 @@ public class DefaultMojoAnnotationsScanner
}
// @Component annotations
- mojoFieldVisitors = mojoClassVisitor.findFieldWithAnnotation( Component.class );
+ List<MojoFieldVisitor> mojoFieldVisitors = mojoClassVisitor.findFieldWithAnnotation( Component.class );
for ( MojoFieldVisitor mojoFieldVisitor : mojoFieldVisitors )
{
ComponentAnnotationContent componentAnnotationContent =
diff --git a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/MojoAnnotationsScanner.java b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/MojoAnnotationsScanner.java
index a4e76199..8308705b 100644
--- a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/MojoAnnotationsScanner.java
+++ b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/MojoAnnotationsScanner.java
@@ -45,6 +45,9 @@ public interface MojoAnnotationsScanner
Component.class.getName(),
Deprecated.class.getName() );
+ List<String> METHOD_LEVEL_ANNOTATIONS = Arrays.asList( Parameter.class.getName(),
+ Deprecated.class.getName() );
+
/**
* Scan classes for mojo annotations.
*
diff --git a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoAnnotationVisitor.java b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoAnnotationVisitor.java
index 296cc01a..225053c1 100644
--- a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoAnnotationVisitor.java
+++ b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoAnnotationVisitor.java
@@ -22,27 +22,25 @@ package org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors;
import java.util.HashMap;
import java.util.Map;
-import org.codehaus.plexus.logging.Logger;
import org.objectweb.asm.AnnotationVisitor;
import org.objectweb.asm.Opcodes;
/**
+ * Visitor for annotations.
+ *
* @author Olivier Lamy
* @since 3.0
*/
public class MojoAnnotationVisitor
extends AnnotationVisitor
{
- private Logger logger;
-
private String annotationClassName;
private Map<String, Object> annotationValues = new HashMap<>();
- MojoAnnotationVisitor( Logger logger, String annotationClassName )
+ MojoAnnotationVisitor( String annotationClassName )
{
super( Opcodes.ASM9 );
- this.logger = logger;
this.annotationClassName = annotationClassName;
}
@@ -66,23 +64,12 @@ public class MojoAnnotationVisitor
@Override
public AnnotationVisitor visitAnnotation( String name, String desc )
{
- return new MojoAnnotationVisitor( logger, this.annotationClassName );
+ return new MojoAnnotationVisitor( this.annotationClassName );
}
@Override
public AnnotationVisitor visitArray( String s )
{
- return new MojoAnnotationVisitor( logger, this.annotationClassName );
- }
-
- @Override
- public void visitEnd()
- {
- // no op
- }
-
- public String getAnnotationClassName()
- {
- return annotationClassName;
+ return new MojoAnnotationVisitor( this.annotationClassName );
}
}
diff --git a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoClassVisitor.java b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoClassVisitor.java
index 40120347..ec155867 100644
--- a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoClassVisitor.java
+++ b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoClassVisitor.java
@@ -19,41 +19,44 @@ package org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors;
* under the License.
*/
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass;
import org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner;
-import org.codehaus.plexus.logging.Logger;
+import org.codehaus.plexus.util.StringUtils;
import org.objectweb.asm.AnnotationVisitor;
-import org.objectweb.asm.Attribute;
import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.FieldVisitor;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;
import org.objectweb.asm.Type;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
/**
+ * Visitor for Mojo classes.
+ *
* @author Olivier Lamy
* @since 3.0
*/
public class MojoClassVisitor
extends ClassVisitor
{
- private Logger logger;
-
private MojoAnnotatedClass mojoAnnotatedClass;
private Map<String, MojoAnnotationVisitor> annotationVisitorMap = new HashMap<>();
private List<MojoFieldVisitor> fieldVisitors = new ArrayList<>();
- public MojoClassVisitor( Logger logger )
+ private List<MojoMethodVisitor> methodVisitors = new ArrayList<>();
+
+ public MojoClassVisitor()
{
super( Opcodes.ASM9 );
- this.logger = logger;
}
public MojoAnnotatedClass getMojoAnnotatedClass()
@@ -61,53 +64,30 @@ public class MojoClassVisitor
return mojoAnnotatedClass;
}
- public void setMojoAnnotatedClass( MojoAnnotatedClass mojoAnnotatedClass )
- {
- this.mojoAnnotatedClass = mojoAnnotatedClass;
- }
-
- public Map<String, MojoAnnotationVisitor> getAnnotationVisitorMap()
- {
- return annotationVisitorMap;
- }
-
public MojoAnnotationVisitor getAnnotationVisitor( Class<?> annotation )
{
return annotationVisitorMap.get( annotation.getName() );
}
- public void setAnnotationVisitorMap( Map<String, MojoAnnotationVisitor> annotationVisitorMap )
- {
- this.annotationVisitorMap = annotationVisitorMap;
- }
-
- public List<MojoFieldVisitor> getFieldVisitors()
- {
- return fieldVisitors;
- }
-
- public void setFieldVisitors( List<MojoFieldVisitor> fieldVisitors )
- {
- this.fieldVisitors = fieldVisitors;
- }
-
public List<MojoFieldVisitor> findFieldWithAnnotation( Class<?> annotation )
{
String annotationClassName = annotation.getName();
- List<MojoFieldVisitor> mojoFieldVisitors = new ArrayList<>();
-
- for ( MojoFieldVisitor mojoFieldVisitor : this.fieldVisitors )
- {
- Map<String, MojoAnnotationVisitor> filedVisitorMap = mojoFieldVisitor.getAnnotationVisitorMap();
+ return fieldVisitors.stream()
+ .filter( field -> field.getAnnotationVisitorMap().containsKey( annotationClassName ) )
+ .collect( Collectors.toList() );
+ }
- if ( filedVisitorMap.containsKey( annotationClassName ) )
- {
- mojoFieldVisitors.add( mojoFieldVisitor );
- }
- }
+ public List<MojoParameterVisitor> findParameterVisitors()
+ {
+ String annotationClassName = Parameter.class.getName();
- return mojoFieldVisitors;
+ return Stream
+ .concat(
+ findFieldWithAnnotation( Parameter.class ).stream(),
+ methodVisitors.stream()
+ .filter( method -> method.getAnnotationVisitorMap().containsKey( annotationClassName ) ) )
+ .collect( Collectors.toList() );
}
@Override
@@ -129,7 +109,7 @@ public class MojoClassVisitor
{
return null;
}
- MojoAnnotationVisitor mojoAnnotationVisitor = new MojoAnnotationVisitor( logger, annotationClassName );
+ MojoAnnotationVisitor mojoAnnotationVisitor = new MojoAnnotationVisitor( annotationClassName );
annotationVisitorMap.put( annotationClassName, mojoAnnotationVisitor );
return mojoAnnotationVisitor;
}
@@ -137,7 +117,7 @@ public class MojoClassVisitor
@Override
public FieldVisitor visitField( int access, String name, String desc, String signature, Object value )
{
- MojoFieldVisitor mojoFieldVisitor = new MojoFieldVisitor( logger, name, Type.getType( desc ).getClassName() );
+ MojoFieldVisitor mojoFieldVisitor = new MojoFieldVisitor( name, Type.getType( desc ).getClassName() );
fieldVisitors.add( mojoFieldVisitor );
return mojoFieldVisitor;
}
@@ -145,38 +125,28 @@ public class MojoClassVisitor
@Override
public MethodVisitor visitMethod( int access, String name, String desc, String signature, String[] exceptions )
{
- // we don't need methods informations
- return null;
- }
+ if ( ( access & Opcodes.ACC_PUBLIC ) != Opcodes.ACC_PUBLIC )
+ {
+ return null;
+ }
- @Override
- public void visitAttribute( Attribute attr )
- {
- // no op
- }
+ if ( !name.startsWith( "set" ) || name.length() < 4 )
+ {
+ return null;
+ }
- @Override
- public void visitSource( String source, String debug )
- {
- // no op
- }
+ Type type = Type.getType( desc );
- @Override
- public void visitOuterClass( String owner, String name, String desc )
- {
- // no op
- }
+ if ( "void".equals( type.getReturnType().getClassName() ) && type.getArgumentTypes().length == 1 )
+ {
+ String fieldName = StringUtils.lowercaseFirstLetter( name.substring( 3 ) );
+ String className = type.getArgumentTypes()[0].getClassName();
- @Override
- public void visitInnerClass( String name, String outerName, String innerName, int access )
- {
- // no op
- }
+ MojoMethodVisitor mojoMethodVisitor = new MojoMethodVisitor( fieldName, className );
+ methodVisitors.add( mojoMethodVisitor );
+ return mojoMethodVisitor;
+ }
- @Override
- public void visitEnd()
- {
- // no op
+ return null;
}
-
}
diff --git a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoFieldVisitor.java b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoFieldVisitor.java
index f69ae060..550bd579 100644
--- a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoFieldVisitor.java
+++ b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoFieldVisitor.java
@@ -23,41 +23,40 @@ import java.util.HashMap;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner;
-import org.codehaus.plexus.logging.Logger;
import org.objectweb.asm.AnnotationVisitor;
-import org.objectweb.asm.Attribute;
import org.objectweb.asm.FieldVisitor;
import org.objectweb.asm.Opcodes;
import org.objectweb.asm.Type;
/**
+ * Visitors for fields.
+ *
* @author Olivier Lamy
* @since 3.0
*/
public class MojoFieldVisitor
- extends FieldVisitor
+ extends FieldVisitor implements MojoParameterVisitor
{
- private Logger logger;
-
private String fieldName;
private Map<String, MojoAnnotationVisitor> annotationVisitorMap = new HashMap<>();
private String className;
- MojoFieldVisitor( Logger logger, String fieldName, String className )
+ MojoFieldVisitor( String fieldName, String className )
{
super( Opcodes.ASM9 );
- this.logger = logger;
this.fieldName = fieldName;
this.className = className;
}
+ @Override
public Map<String, MojoAnnotationVisitor> getAnnotationVisitorMap()
{
return annotationVisitorMap;
}
+ @Override
public String getFieldName()
{
return fieldName;
@@ -71,30 +70,14 @@ public class MojoFieldVisitor
{
return null;
}
- MojoAnnotationVisitor mojoAnnotationVisitor = new MojoAnnotationVisitor( logger, annotationClassName );
+ MojoAnnotationVisitor mojoAnnotationVisitor = new MojoAnnotationVisitor( annotationClassName );
annotationVisitorMap.put( annotationClassName, mojoAnnotationVisitor );
return mojoAnnotationVisitor;
}
@Override
- public void visitAttribute( Attribute attribute )
- {
- // no op
- }
-
- @Override
- public void visitEnd()
- {
- // no op
- }
-
public String getClassName()
{
return className;
}
-
- public void setClassName( String className )
- {
- this.className = className;
- }
}
diff --git a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoFieldVisitor.java b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoMethodVisitor.java
similarity index 72%
copy from maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoFieldVisitor.java
copy to maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoMethodVisitor.java
index f69ae060..448bb788 100644
--- a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoFieldVisitor.java
+++ b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoMethodVisitor.java
@@ -23,78 +23,59 @@ import java.util.HashMap;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner;
-import org.codehaus.plexus.logging.Logger;
import org.objectweb.asm.AnnotationVisitor;
-import org.objectweb.asm.Attribute;
-import org.objectweb.asm.FieldVisitor;
+import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;
import org.objectweb.asm.Type;
/**
- * @author Olivier Lamy
- * @since 3.0
+ * Method visitor.
+ *
+ * @author Slawomir Jaranowski
*/
-public class MojoFieldVisitor
- extends FieldVisitor
+public class MojoMethodVisitor extends MethodVisitor implements MojoParameterVisitor
{
- private Logger logger;
-
- private String fieldName;
+ private final String className;
+ private final String fieldName;
private Map<String, MojoAnnotationVisitor> annotationVisitorMap = new HashMap<>();
- private String className;
-
- MojoFieldVisitor( Logger logger, String fieldName, String className )
+ public MojoMethodVisitor( String fieldName, String className )
{
super( Opcodes.ASM9 );
- this.logger = logger;
this.fieldName = fieldName;
this.className = className;
}
- public Map<String, MojoAnnotationVisitor> getAnnotationVisitorMap()
- {
- return annotationVisitorMap;
- }
-
- public String getFieldName()
- {
- return fieldName;
- }
-
@Override
public AnnotationVisitor visitAnnotation( String desc, boolean visible )
{
String annotationClassName = Type.getType( desc ).getClassName();
- if ( !MojoAnnotationsScanner.FIELD_LEVEL_ANNOTATIONS.contains( annotationClassName ) )
+ if ( !MojoAnnotationsScanner.METHOD_LEVEL_ANNOTATIONS.contains( annotationClassName ) )
{
return null;
}
- MojoAnnotationVisitor mojoAnnotationVisitor = new MojoAnnotationVisitor( logger, annotationClassName );
+
+ MojoAnnotationVisitor mojoAnnotationVisitor = new MojoAnnotationVisitor( annotationClassName );
annotationVisitorMap.put( annotationClassName, mojoAnnotationVisitor );
return mojoAnnotationVisitor;
}
@Override
- public void visitAttribute( Attribute attribute )
+ public String getFieldName()
{
- // no op
+ return fieldName;
}
@Override
- public void visitEnd()
- {
- // no op
- }
-
public String getClassName()
{
return className;
}
- public void setClassName( String className )
+ @Override
+ public Map<String, MojoAnnotationVisitor> getAnnotationVisitorMap()
{
- this.className = className;
+ return annotationVisitorMap;
}
}
diff --git a/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoParameterVisitor.java b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoParameterVisitor.java
new file mode 100644
index 00000000..c95ac05c
--- /dev/null
+++ b/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/visitors/MojoParameterVisitor.java
@@ -0,0 +1,36 @@
+package org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import java.util.Map;
+
+/**
+ * Common interface for field and method visitors.
+ *
+ * @author Slawomir Jaranowski
+ */
+public interface MojoParameterVisitor
+{
+ String getFieldName();
+
+ String getClassName();
+
+ Map<String, MojoAnnotationVisitor> getAnnotationVisitorMap();
+}
diff --git a/maven-plugin-tools-annotations/src/site/apt/index.apt b/maven-plugin-tools-annotations/src/site/apt/index.apt
index db372a25..14d0b2da 100644
--- a/maven-plugin-tools-annotations/src/site/apt/index.apt
+++ b/maven-plugin-tools-annotations/src/site/apt/index.apt
@@ -115,6 +115,15 @@ public class MyMojo
@Parameter( defaultValue = "${project.build.directory}", readonly = true )
private File target;
+ /**
+ * @Parameter for methods can be used only with public setter methods
+ */
+ @Parameter( ... )
+ public setOutput( File output )
+ {
+ ...
+ }
+
public void execute()
{
...
diff --git a/maven-plugin-tools-annotations/src/test/java/org/apache/maven/tools/plugin/extractor/annotations/FooMojo.java b/maven-plugin-tools-annotations/src/test/java/org/apache/maven/tools/plugin/extractor/annotations/FooMojo.java
index 36dd9737..8fa46821 100644
--- a/maven-plugin-tools-annotations/src/test/java/org/apache/maven/tools/plugin/extractor/annotations/FooMojo.java
+++ b/maven-plugin-tools-annotations/src/test/java/org/apache/maven/tools/plugin/extractor/annotations/FooMojo.java
@@ -19,6 +19,8 @@ package org.apache.maven.tools.plugin.extractor.annotations;
* under the License.
*/
+import java.util.List;
+
import org.apache.maven.artifact.metadata.ArtifactMetadataSource;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
@@ -57,6 +59,27 @@ public class FooMojo
@Parameter( property = "thebeer", defaultValue = "coolbeer" )
protected String beer;
+ /**
+ * setter as parameter.
+ */
+ @Parameter( property = "props.paramFromSetter" )
+ public void setParamFromSetter(String value)
+ {
+ // empty
+ }
+
+ /**
+ * deprecated setter as parameter.
+ *
+ * @deprecated reason of deprecation
+ */
+ @Deprecated
+ @Parameter( property = "props.paramFromSetterDeprecated" )
+ public void setParamFromSetterDeprecated( List<String> value)
+ {
+ // empty
+ }
+
/**
*
*/
@@ -69,4 +92,10 @@ public class FooMojo
{
// nothing
}
+
+ @Deprecated
+ public void deprecatedMethod(String value)
+ {
+
+ }
}
diff --git a/maven-plugin-tools-annotations/src/test/java/org/apache/maven/tools/plugin/extractor/annotations/TestAnnotationsReader.java b/maven-plugin-tools-annotations/src/test/java/org/apache/maven/tools/plugin/extractor/annotations/TestAnnotationsReader.java
index 797f46e7..d05aac51 100644
--- a/maven-plugin-tools-annotations/src/test/java/org/apache/maven/tools/plugin/extractor/annotations/TestAnnotationsReader.java
+++ b/maven-plugin-tools-annotations/src/test/java/org/apache/maven/tools/plugin/extractor/annotations/TestAnnotationsReader.java
@@ -25,6 +25,7 @@ import java.io.File;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
+import java.util.List;
import java.util.Map;
import org.apache.maven.plugins.annotations.Execute;
@@ -94,8 +95,8 @@ class TestAnnotationsReader
Collection<ParameterAnnotationContent> parameters = mojoAnnotatedClass.getParameters().values();
assertThat( parameters ).isNotNull()
.isNotEmpty()
- .hasSize( 3 )
- .contains(
+ .hasSize( 5 )
+ .containsExactlyInAnyOrder(
new ParameterAnnotationContent( "bar", null, "thebar", "coolbar", null, true, false,
String.class.getName() ),
new ParameterAnnotationContent( "beer", null, "thebeer", "coolbeer", null, false, false,
@@ -103,7 +104,15 @@ class TestAnnotationsReader
new ParameterAnnotationContent( "fooInterface", null, "fooInterface", null,
FooInterfaceImpl.class,
false,
- false, FooInterface.class.getName() )
+ false, FooInterface.class.getName() ),
+ new ParameterAnnotationContent( "paramFromSetter", null, "props.paramFromSetter", null,
+ null,
+ false,
+ false, String.class.getName() ),
+ new ParameterAnnotationContent( "paramFromSetterDeprecated", null, "props.paramFromSetterDeprecated", null,
+ null,
+ false,
+ false, List.class.getName() )
);
}
}