jvanzyl 2004/03/19 08:12:27
Modified: maven-core/src/main/java/org/apache/maven/plugin/descriptor
GoalDescriptor.java MethodDescriptor.java
PluginDescriptorBuilder.java
maven-core/src/main/java/org/apache/maven/plugin/plexus
FieldPluginConfigurator.java
PlexusPluginManager.java
SetterPluginConfigurator.java
maven-core/src/test/java/org/apache/maven/plugin
PluginConfiguratorTest.java
PluginDescriptorBuilderTest.java
maven-core/src/test/resources/org/apache/maven/plugin
field-plugin.xml integrated-plugin.xml
setter-plugin.xml singleton-plugin.xml
Added: maven-core/src/main/java/org/apache/maven/plugin/descriptor
ParameterDescriptor.java
Log:
o align all the POJO plugin configurations to use a <parameters/> element.
o defined a <parameter/> element that currently uses a name and expression
but can be expanded to provide desriptions, type inforation, and
validation information for systems using the plugins within a
user-centric environment like an IDE.
Revision Changes Path
1.2 +3 -26
maven-components/maven-core/src/main/java/org/apache/maven/plugin/descriptor/GoalDescriptor.java
Index: GoalDescriptor.java
===================================================================
RCS file:
/home/cvs/maven-components/maven-core/src/main/java/org/apache/maven/plugin/descriptor/GoalDescriptor.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- GoalDescriptor.java 19 Mar 2004 04:13:20 -0000 1.1
+++ GoalDescriptor.java 19 Mar 2004 16:12:26 -0000 1.2
@@ -1,7 +1,5 @@
package org.apache.maven.plugin.descriptor;
-import org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration;
-
import java.util.List;
/**
@@ -15,13 +13,7 @@
{
private String name;
- private XmlPlexusConfiguration configuration;
-
- private XmlPlexusConfiguration parameters;
-
- private XmlPlexusConfiguration setters;
-
- private XmlPlexusConfiguration fields;
+ private List parameters;
private List prereqs;
@@ -34,11 +26,6 @@
return name;
}
- public XmlPlexusConfiguration getConfiguration()
- {
- return configuration;
- }
-
public List getPrereqs()
{
return prereqs;
@@ -54,17 +41,7 @@
return method;
}
- public XmlPlexusConfiguration getSetters()
- {
- return setters;
- }
-
- public XmlPlexusConfiguration getFields()
- {
- return fields;
- }
-
- public XmlPlexusConfiguration getParameters()
+ public List getParameters()
{
return parameters;
}
1.2 +6 -4
maven-components/maven-core/src/main/java/org/apache/maven/plugin/descriptor/MethodDescriptor.java
Index: MethodDescriptor.java
===================================================================
RCS file:
/home/cvs/maven-components/maven-core/src/main/java/org/apache/maven/plugin/descriptor/MethodDescriptor.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- MethodDescriptor.java 19 Mar 2004 04:13:20 -0000 1.1
+++ MethodDescriptor.java 19 Mar 2004 16:12:27 -0000 1.2
@@ -2,9 +2,11 @@
import org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration;
+import java.util.List;
+
/**
*
- *
+ *
* @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a>
*
* @version $Id$
@@ -13,14 +15,14 @@
{
private String name;
- private XmlPlexusConfiguration parameters;
+ private List parameters;
public String getName()
{
return name;
}
- public XmlPlexusConfiguration getParameters()
+ public List getParameters()
{
return parameters;
}
1.2 +3 -11
maven-components/maven-core/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptorBuilder.java
Index: PluginDescriptorBuilder.java
===================================================================
RCS file:
/home/cvs/maven-components/maven-core/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptorBuilder.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PluginDescriptorBuilder.java 19 Mar 2004 04:13:20 -0000 1.1
+++ PluginDescriptorBuilder.java 19 Mar 2004 16:12:27 -0000 1.2
@@ -2,12 +2,9 @@
import org.codehaus.plexus.configuration.PlexusConfiguration;
import org.codehaus.plexus.configuration.xml.xstream.PlexusXStream;
-import org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration;
-import org.apache.maven.plugin.descriptor.GoalDescriptor;
-import org.apache.maven.plugin.descriptor.PluginDescriptor;
-import java.io.StringReader;
import java.io.Reader;
+import java.io.StringReader;
/**
*
@@ -32,12 +29,7 @@
xstream.alias( "method", MethodDescriptor.class );
- xstream.alias( "parameters", XmlPlexusConfiguration.class );
-
- xstream.alias( "fields", XmlPlexusConfiguration.class );
-
- xstream.alias( "setters", XmlPlexusConfiguration.class );
-
+ xstream.alias( "parameter", ParameterDescriptor.class );
}
public PluginDescriptor build( Reader reader )
1.1
maven-components/maven-core/src/main/java/org/apache/maven/plugin/descriptor/ParameterDescriptor.java
Index: ParameterDescriptor.java
===================================================================
package org.apache.maven.plugin.descriptor;
/**
*
*
* @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a>
*
* @version $Id: ParameterDescriptor.java,v 1.1 2004/03/19 16:12:27 jvanzyl Exp $
*/
public class ParameterDescriptor
{
private String name;
private String expression;
private String description;
public String getName()
{
return name;
}
public String getExpression()
{
return expression;
}
public String getDescription()
{
return description;
}
}
1.2 +7 -6
maven-components/maven-core/src/main/java/org/apache/maven/plugin/plexus/FieldPluginConfigurator.java
Index: FieldPluginConfigurator.java
===================================================================
RCS file:
/home/cvs/maven-components/maven-core/src/main/java/org/apache/maven/plugin/plexus/FieldPluginConfigurator.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- FieldPluginConfigurator.java 19 Mar 2004 04:13:20 -0000 1.1
+++ FieldPluginConfigurator.java 19 Mar 2004 16:12:27 -0000 1.2
@@ -1,9 +1,10 @@
package org.apache.maven.plugin.plexus;
+import org.apache.maven.plugin.descriptor.ParameterDescriptor;
import org.apache.maven.project.MavenProject;
-import org.codehaus.plexus.configuration.PlexusConfiguration;
import java.lang.reflect.Field;
+import java.util.List;
/**
*
@@ -14,20 +15,20 @@
*/
public class FieldPluginConfigurator
{
- public Object configure( Object plugin, PlexusConfiguration configuration,
MavenProject project )
+ public Object configure( Object plugin, List parameters, MavenProject project )
throws PluginConfigurationException, Exception
{
Class pluginClass = plugin.getClass();
- int size = configuration.getChildCount();
+ int size = parameters.size();
for ( int i = 0; i < size; i++ )
{
- PlexusConfiguration c = configuration.getChild( i );
+ ParameterDescriptor c = (ParameterDescriptor) parameters.get( i );
String fieldName = c.getName();
- String expression = c.getValue();
+ String expression = c.getExpression();
Object value = OgnlProjectValueExtractor.evaluate( expression, project
);
1.2 +14 -14
maven-components/maven-core/src/main/java/org/apache/maven/plugin/plexus/PlexusPluginManager.java
Index: PlexusPluginManager.java
===================================================================
RCS file:
/home/cvs/maven-components/maven-core/src/main/java/org/apache/maven/plugin/plexus/PlexusPluginManager.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PlexusPluginManager.java 19 Mar 2004 04:13:20 -0000 1.1
+++ PlexusPluginManager.java 19 Mar 2004 16:12:27 -0000 1.2
@@ -5,18 +5,19 @@
import org.apache.maven.plugin.PluginExecutionResponse;
import org.apache.maven.plugin.descriptor.GoalDescriptor;
import org.apache.maven.plugin.descriptor.MethodDescriptor;
+import org.apache.maven.plugin.descriptor.ParameterDescriptor;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.plugin.manager.AbstractPluginManager;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.PlexusConstants;
import org.codehaus.plexus.PlexusContainer;
-import org.codehaus.plexus.configuration.PlexusConfiguration;
import org.codehaus.plexus.context.Context;
import org.codehaus.plexus.context.ContextException;
import org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable;
import java.lang.reflect.Method;
import java.util.HashMap;
+import java.util.List;
import java.util.Map;
/**
@@ -83,19 +84,19 @@
private void executeIntegratedPlugin( Object plugin, GoalDescriptor gd,
MavenProject project )
throws Exception
{
- PlexusConfiguration parameters = gd.getParameters();
+ List parameters = gd.getParameters();
- int size = parameters.getChildCount();
+ int size = parameters.size();
Map map = new HashMap();
for ( int i = 0; i < size; i++ )
{
- PlexusConfiguration c = parameters.getChild( i );
+ ParameterDescriptor c = (ParameterDescriptor) parameters.get( i );
String key = c.getName();
- String expression = c.getValue();
+ String expression = c.getExpression();
Object value = OgnlProjectValueExtractor.evaluate( expression, project
);
@@ -114,15 +115,15 @@
{
MethodDescriptor md = gd.getMethod();
- int size = md.getParameters().getChildCount();
+ int size = md.getParameters().size();
Object[] parameters = new Object[size];
for ( int i = 0; i < size; i++ )
{
- PlexusConfiguration c = md.getParameters().getChild( i );
+ ParameterDescriptor c = (ParameterDescriptor) md.getParameters().get(
i );
- String expression = c.getValue();
+ String expression = c.getExpression();
parameters[i] = OgnlProjectValueExtractor.evaluate( expression, project
);
}
@@ -154,9 +155,9 @@
private void executeFieldPlugin( Object plugin, GoalDescriptor gd, MavenProject
project )
throws Exception
{
- if ( gd.getFields().getChildCount() != 0 )
+ if ( gd.getParameters() != null )
{
- plugin = fieldPluginConfigurator.configure( plugin, gd.getFields(),
project );
+ plugin = fieldPluginConfigurator.configure( plugin, gd.getParameters(),
project );
}
Method m = plugin.getClass().getMethod( "execute", new Class[0] );
@@ -167,9 +168,9 @@
private void executeSetterPlugin( Object plugin, GoalDescriptor gd,
MavenProject project )
throws Exception
{
- if ( gd.getSetters().getChildCount() != 0 )
+ if ( gd.getParameters() != null )
{
- plugin = setterPluginConfigurator.configure( plugin, gd.getSetters(),
project );
+ plugin = setterPluginConfigurator.configure( plugin,
gd.getParameters(), project );
}
Method m = plugin.getClass().getMethod( "execute", new Class[0] );
@@ -181,7 +182,6 @@
// Lifecylce Management
// ----------------------------------------------------------------------
- /** @see Contextualizable#contextualize */
public void contextualize( Context context )
throws ContextException
{
1.2 +7 -6
maven-components/maven-core/src/main/java/org/apache/maven/plugin/plexus/SetterPluginConfigurator.java
Index: SetterPluginConfigurator.java
===================================================================
RCS file:
/home/cvs/maven-components/maven-core/src/main/java/org/apache/maven/plugin/plexus/SetterPluginConfigurator.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SetterPluginConfigurator.java 19 Mar 2004 04:13:20 -0000 1.1
+++ SetterPluginConfigurator.java 19 Mar 2004 16:12:27 -0000 1.2
@@ -1,9 +1,10 @@
package org.apache.maven.plugin.plexus;
+import org.apache.maven.plugin.descriptor.ParameterDescriptor;
import org.apache.maven.project.MavenProject;
-import org.codehaus.plexus.configuration.PlexusConfiguration;
import java.lang.reflect.Method;
+import java.util.List;
/**
*
@@ -14,20 +15,20 @@
*/
public class SetterPluginConfigurator
{
- public Object configure( Object plugin, PlexusConfiguration configuration,
MavenProject project )
+ public Object configure( Object plugin, List parameters, MavenProject project )
throws PluginConfigurationException, Exception
{
Class pluginClass = plugin.getClass();
- int size = configuration.getChildCount();
+ int size = parameters.size();
for ( int i = 0; i < size; i++ )
{
- PlexusConfiguration c = configuration.getChild( i );
+ ParameterDescriptor c = (ParameterDescriptor) parameters.get( i );
String methodName = "set" + capitalise( c.getName() );
- String expression = c.getValue();
+ String expression = c.getExpression();
Object value = OgnlProjectValueExtractor.evaluate( expression, project
);
1.2 +26 -15
maven-components/maven-core/src/test/java/org/apache/maven/plugin/PluginConfiguratorTest.java
Index: PluginConfiguratorTest.java
===================================================================
RCS file:
/home/cvs/maven-components/maven-core/src/test/java/org/apache/maven/plugin/PluginConfiguratorTest.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PluginConfiguratorTest.java 19 Mar 2004 04:13:18 -0000 1.1
+++ PluginConfiguratorTest.java 19 Mar 2004 16:12:27 -0000 1.2
@@ -1,15 +1,13 @@
package org.apache.maven.plugin;
import junit.framework.TestCase;
-
-import java.util.List;
-import java.util.Properties;
-
-import org.apache.maven.project.MavenProject;
-import org.apache.maven.plugin.plexus.FieldPluginConfigurator;
-import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.plugin.descriptor.GoalDescriptor;
+import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.plugin.descriptor.PluginDescriptorBuilder;
+import org.apache.maven.plugin.plexus.FieldPluginConfigurator;
+import org.apache.maven.project.MavenProject;
+
+import java.util.Properties;
/**
*
@@ -28,15 +26,28 @@
"<plugin>" +
" <id>compiler</id>" +
" <implementation>implementation</implementation>" +
+ " <mode>field</mode>" +
" <goals>" +
" <goal>" +
" <name>compile</name>" +
- " <configuration>" +
- " <sourceDirectory>sourceDirectory</sourceDirectory>" +
- " <outputDirectory>outputDirectory</outputDirectory>" +
- " <classpathElements>classpathElements</classpathElements>" +
- " <compiler>javac</compiler>" +
- " </configuration>" +
+ " <parameters>" +
+ " <parameter>" +
+ " <name>sourceDirectory</name>" +
+ " <expression>sourceDirectory</expression>" +
+ " </parameter>" +
+ " <parameter>" +
+ " <name>outputDirectory</name>" +
+ " <expression>outputDirectory</expression>" +
+ " </parameter>" +
+ " <parameter>" +
+ " <name>classpathElements</name>" +
+ " <expression>classpathElements</expression>" +
+ " </parameter>" +
+ " <parameter>" +
+ " <name>compiler</name>" +
+ " <expression>javac</expression>" +
+ " </parameter>" +
+ " </parameters>" +
" </goal>" +
" </goals>" +
"</plugin>";
@@ -55,7 +66,7 @@
GoalDescriptor gd = (GoalDescriptor) pd.getGoals().get( 0 );
- plugin = (MockPlugin) pc.configure( plugin, gd.getConfiguration(), project
);
+ plugin = (MockPlugin) pc.configure( plugin, gd.getParameters(), project );
}
1.2 +28 -13
maven-components/maven-core/src/test/java/org/apache/maven/plugin/PluginDescriptorBuilderTest.java
Index: PluginDescriptorBuilderTest.java
===================================================================
RCS file:
/home/cvs/maven-components/maven-core/src/test/java/org/apache/maven/plugin/PluginDescriptorBuilderTest.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PluginDescriptorBuilderTest.java 19 Mar 2004 04:13:18 -0000 1.1
+++ PluginDescriptorBuilderTest.java 19 Mar 2004 16:12:27 -0000 1.2
@@ -4,6 +4,7 @@
import org.apache.maven.plugin.descriptor.GoalDescriptor;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.plugin.descriptor.PluginDescriptorBuilder;
+import org.apache.maven.plugin.descriptor.ParameterDescriptor;
import org.codehaus.plexus.configuration.PlexusConfiguration;
import java.util.List;
@@ -24,15 +25,29 @@
String xml =
"<plugin>" +
" <id>compiler</id>" +
+ " <implementation>implementation</implementation>" +
+ " <mode>field</mode>" +
" <goals>" +
" <goal>" +
" <name>compile</name>" +
- " <configuration>" +
- " <sourceDirectory>#build.sourceDirectory</sourceDirectory>" +
- " <outputDirectory>maven.build.dest</outputDirectory>" +
- " <classpathElements>#classpathElements</classpathElements>" +
- " <compiler>javac</compiler>" +
- " </configuration>" +
+ " <parameters>" +
+ " <parameter>" +
+ " <name>sourceDirectory</name>" +
+ " <expression>sourceDirectory</expression>" +
+ " </parameter>" +
+ " <parameter>" +
+ " <name>outputDirectory</name>" +
+ " <expression>outputDirectory</expression>" +
+ " </parameter>" +
+ " <parameter>" +
+ " <name>classpathElements</name>" +
+ " <expression>classpathElements</expression>" +
+ " </parameter>" +
+ " <parameter>" +
+ " <name>compiler</name>" +
+ " <expression>javac</expression>" +
+ " </parameter>" +
+ " </parameters>" +
" </goal>" +
" </goals>" +
"</plugin>";
@@ -51,16 +66,16 @@
assertEquals( "compile", goal.getName() );
- PlexusConfiguration configuration = goal.getConfiguration();
+ List parameters = goal.getParameters();
- assertNotNull( configuration );
+ assertNotNull( parameters );
- assertEquals( "#build.sourceDirectory", configuration.getChild(
"sourceDirectory" ).getValue() );
+ assertEquals( "#build.sourceDirectory", ((ParameterDescriptor)
parameters.get( 0 ) ).getName() );
- assertEquals( "maven.build.dest", configuration.getChild( "outputDirectory"
).getValue() );
+ assertEquals( "maven.build.dest", ((ParameterDescriptor) parameters.get( 1
) ).getName() );
- assertEquals( "#classpathElements", configuration.getChild(
"classpathElements" ).getValue() );
+ assertEquals( "#classpathElements",((ParameterDescriptor) parameters.get( 2
) ).getName() );
- assertEquals( "javac", configuration.getChild( "compiler" ).getValue() );
+ assertEquals( "javac",((ParameterDescriptor) parameters.get( 3 )
).getName() );
}
}
1.2 +14 -5
maven-components/maven-core/src/test/resources/org/apache/maven/plugin/field-plugin.xml
Index: field-plugin.xml
===================================================================
RCS file:
/home/cvs/maven-components/maven-core/src/test/resources/org/apache/maven/plugin/field-plugin.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- field-plugin.xml 19 Mar 2004 04:13:18 -0000 1.1
+++ field-plugin.xml 19 Mar 2004 16:12:27 -0000 1.2
@@ -5,11 +5,20 @@
<goals>
<goal>
<name>field-execute</name>
- <fields>
- <name>#project.name</name>
- <artifactId>#project.artifactId</artifactId>
- <foo>#foo</foo>
- </fields>
+ <parameters>
+ <parameter>
+ <name>name</name>
+ <expression>#project.name</expression>
+ </parameter>
+ <parameter>
+ <name>artifactId</name>
+ <expression>#project.artifactId</expression>
+ </parameter>
+ <parameter>
+ <name>foo</name>
+ <expression>#foo</expression>
+ </parameter>
+ </parameters>
</goal>
</goals>
</plugin>
1.2 +12 -3
maven-components/maven-core/src/test/resources/org/apache/maven/plugin/integrated-plugin.xml
Index: integrated-plugin.xml
===================================================================
RCS file:
/home/cvs/maven-components/maven-core/src/test/resources/org/apache/maven/plugin/integrated-plugin.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- integrated-plugin.xml 19 Mar 2004 04:13:18 -0000 1.1
+++ integrated-plugin.xml 19 Mar 2004 16:12:27 -0000 1.2
@@ -6,9 +6,18 @@
<goal>
<name>integrated-execute</name>
<parameters>
- <name>#project.name</name>
- <artifactId>#project.artifactId</artifactId>
- <foo>#foo</foo>
+ <parameter>
+ <name>name</name>
+ <expression>#project.name</expression>
+ </parameter>
+ <parameter>
+ <name>artifactId</name>
+ <expression>#project.artifactId</expression>
+ </parameter>
+ <parameter>
+ <name>foo</name>
+ <expression>#foo</expression>
+ </parameter>
</parameters>
</goal>
</goals>
1.2 +14 -5
maven-components/maven-core/src/test/resources/org/apache/maven/plugin/setter-plugin.xml
Index: setter-plugin.xml
===================================================================
RCS file:
/home/cvs/maven-components/maven-core/src/test/resources/org/apache/maven/plugin/setter-plugin.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- setter-plugin.xml 19 Mar 2004 04:13:18 -0000 1.1
+++ setter-plugin.xml 19 Mar 2004 16:12:27 -0000 1.2
@@ -5,11 +5,20 @@
<goals>
<goal>
<name>setter-execute</name>
- <setters>
- <name>#project.name</name>
- <artifactId>#project.artifactId</artifactId>
- <foo>#foo</foo>
- </setters>
+ <parameters>
+ <parameter>
+ <name>name</name>
+ <expression>#project.name</expression>
+ </parameter>
+ <parameter>
+ <name>artifactId</name>
+ <expression>#project.artifactId</expression>
+ </parameter>
+ <parameter>
+ <name>foo</name>
+ <expression>#foo</expression>
+ </parameter>
+ </parameters>
</goal>
</goals>
</plugin>
1.2 +12 -3
maven-components/maven-core/src/test/resources/org/apache/maven/plugin/singleton-plugin.xml
Index: singleton-plugin.xml
===================================================================
RCS file:
/home/cvs/maven-components/maven-core/src/test/resources/org/apache/maven/plugin/singleton-plugin.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- singleton-plugin.xml 19 Mar 2004 04:13:18 -0000 1.1
+++ singleton-plugin.xml 19 Mar 2004 16:12:27 -0000 1.2
@@ -8,9 +8,18 @@
<method>
<name>execute</name>
<parameters>
- <name>#project.name</name>
- <artifactId>#project.artifactId</artifactId>
- <foo>#foo</foo>
+ <parameter>
+ <name>name</name>
+ <expression>#project.name</expression>
+ </parameter>
+ <parameter>
+ <name>artifactId</name>
+ <expression>#project.artifactId</expression>
+ </parameter>
+ <parameter>
+ <name>foo</name>
+ <expression>#foo</expression>
+ </parameter>
</parameters>
</method>
</goal>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]