o Polished code

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@938263 13f79535-47bb-0310-9956-ffa450edef68
master
Benjamin Bentmann 2010-04-26 22:48:25 +00:00
parent 3da36fb45d
commit b8a9bbe373
10 changed files with 35 additions and 26 deletions

View File

@ -41,12 +41,12 @@ public class ExtendedMojoDescriptor
this.threadSafe = threadSafe; this.threadSafe = threadSafe;
} }
public String getRequiresDependencyCollection() public String getDependencyCollectionRequired()
{ {
return requiresDependencyCollection; return requiresDependencyCollection;
} }
public void setRequiresDependencyCollection( String requiresDependencyCollection ) public void setDependencyCollectionRequired( String requiresDependencyCollection )
{ {
this.requiresDependencyCollection = requiresDependencyCollection; this.requiresDependencyCollection = requiresDependencyCollection;
} }

View File

@ -309,14 +309,13 @@ public class PluginDescriptorGenerator
if ( mojoDescriptor instanceof ExtendedMojoDescriptor ) if ( mojoDescriptor instanceof ExtendedMojoDescriptor )
{ {
ExtendedMojoDescriptor extendedMojoDescriptor = (ExtendedMojoDescriptor) mojoDescriptor; ExtendedMojoDescriptor extendedMojoDescriptor = (ExtendedMojoDescriptor) mojoDescriptor;
if ( extendedMojoDescriptor.getRequiresDependencyCollection() != null ) if ( extendedMojoDescriptor.getDependencyCollectionRequired() != null )
{ {
PluginUtils.element( w, "requiresDependencyCollection", PluginUtils.element( w, "requiresDependencyCollection",
extendedMojoDescriptor.getRequiresDependencyCollection() ); extendedMojoDescriptor.getDependencyCollectionRequired() );
} }
PluginUtils.element( w, "threadSafe", "" + ( (ExtendedMojoDescriptor) mojoDescriptor ).isThreadSafe() ); PluginUtils.element( w, "threadSafe", "" + extendedMojoDescriptor.isThreadSafe() );
} }
// ---------------------------------------------------------------------- // ----------------------------------------------------------------------

View File

@ -313,7 +313,7 @@ public class PluginXdocGenerator
{ {
ExtendedMojoDescriptor extendedMojoDescriptor = (ExtendedMojoDescriptor) mojoDescriptor; ExtendedMojoDescriptor extendedMojoDescriptor = (ExtendedMojoDescriptor) mojoDescriptor;
value = extendedMojoDescriptor.getRequiresDependencyCollection(); value = extendedMojoDescriptor.getDependencyCollectionRequired();
if ( StringUtils.isNotEmpty( value ) ) if ( StringUtils.isNotEmpty( value ) )
{ {
if ( !addedUl ) if ( !addedUl )

View File

@ -54,4 +54,4 @@ pluginxdoc.mojodescriptor.requiredParameters=Required Parameters
pluginxdoc.mojodescriptor.optionalParameters=Optional Parameters pluginxdoc.mojodescriptor.optionalParameters=Optional Parameters
pluginxdoc.mojodescriptor.parameters=Parameters pluginxdoc.mojodescriptor.parameters=Parameters
pluginxdoc.mojodescriptor.noParameter=(no parameters) pluginxdoc.mojodescriptor.noParameter=(no parameters)
pluginxdoc.mojodescriptor.threadSafe=The mojo is threadsafe pluginxdoc.mojodescriptor.threadSafe=The goal is thread-safe and supports parallel builds.

View File

@ -29,6 +29,7 @@ pluginxdoc.mojodescriptor.projectRequired=Erfordert ein Maven 2.0 Projet zur Aus
pluginxdoc.mojodescriptor.aggregator=Wird als Aggregator ausgef\u00fchrt. pluginxdoc.mojodescriptor.aggregator=Wird als Aggregator ausgef\u00fchrt.
pluginxdoc.mojodescriptor.directInvocationOnly=Wird nur per direktem Aufruf ausgef\u00fchrt. pluginxdoc.mojodescriptor.directInvocationOnly=Wird nur per direktem Aufruf ausgef\u00fchrt.
pluginxdoc.mojodescriptor.dependencyResolutionRequired=Erfordert Abh\u00e4ngigkeitsaufl\u00f6sung von Artefakten mit Geltungsbereich: <code>{0}</code>. pluginxdoc.mojodescriptor.dependencyResolutionRequired=Erfordert Abh\u00e4ngigkeitsaufl\u00f6sung von Artefakten mit Geltungsbereich: <code>{0}</code>.
pluginxdoc.mojodescriptor.dependencyCollectionRequired=Erfordert Abh\u00e4ngigkeitsermittlung von Artefakten mit Geltungsbereich: <code>{0}</code>.
pluginxdoc.mojodescriptor.since=Seit Version: <code>{0}</code>. pluginxdoc.mojodescriptor.since=Seit Version: <code>{0}</code>.
pluginxdoc.mojodescriptor.phase=Bindet automatisch an die Lebenszyklusphase: <code>{0}</code>. pluginxdoc.mojodescriptor.phase=Bindet automatisch an die Lebenszyklusphase: <code>{0}</code>.
pluginxdoc.mojodescriptor.executePhase=Bedingt die Ausf\u00fchrung der Lebenszyklusphase <code>{0}</code> vor seiner eigenen Ausf\u00fchrung. pluginxdoc.mojodescriptor.executePhase=Bedingt die Ausf\u00fchrung der Lebenszyklusphase <code>{0}</code> vor seiner eigenen Ausf\u00fchrung.
@ -50,3 +51,4 @@ pluginxdoc.mojodescriptor.requiredParameters=Erforderliche Parameter
pluginxdoc.mojodescriptor.optionalParameters=Optionale Parameter pluginxdoc.mojodescriptor.optionalParameters=Optionale Parameter
pluginxdoc.mojodescriptor.parameters=Parameter pluginxdoc.mojodescriptor.parameters=Parameter
pluginxdoc.mojodescriptor.noParameter=(keine Parameter) pluginxdoc.mojodescriptor.noParameter=(keine Parameter)
pluginxdoc.mojodescriptor.threadSafe=Dieses Goal is thread-sicher und unterst\u00fctzt paralleles Bauen.

View File

@ -30,6 +30,7 @@ pluginxdoc.mojodescriptor.projectRequired=Exige un projet Maven 2.0 pour \u00eat
pluginxdoc.mojodescriptor.aggregator=S'ex\u00e9cute comme un plugin agr\u00e9g\u00e9. pluginxdoc.mojodescriptor.aggregator=S'ex\u00e9cute comme un plugin agr\u00e9g\u00e9.
pluginxdoc.mojodescriptor.directInvocationOnly=S'ex\u00e9cute par l'invocation directe seulement. pluginxdoc.mojodescriptor.directInvocationOnly=S'ex\u00e9cute par l'invocation directe seulement.
pluginxdoc.mojodescriptor.dependencyResolutionRequired=Exige une r\u00e9solution de d\u00e9pendances des artefacts dans le scope : <code>{0}</code>. pluginxdoc.mojodescriptor.dependencyResolutionRequired=Exige une r\u00e9solution de d\u00e9pendances des artefacts dans le scope : <code>{0}</code>.
pluginxdoc.mojodescriptor.dependencyCollectionRequired=Exige une collection de d\u00e9pendances des artefacts dans le scope : <code>{0}</code>.
pluginxdoc.mojodescriptor.since=Depuis la version : <code>{0}</code>. pluginxdoc.mojodescriptor.since=Depuis la version : <code>{0}</code>.
pluginxdoc.mojodescriptor.phase=S'associe par d\u00e9faut dans la phase du cycle de vie : <code>{0}</code>. pluginxdoc.mojodescriptor.phase=S'associe par d\u00e9faut dans la phase du cycle de vie : <code>{0}</code>.
pluginxdoc.mojodescriptor.executePhase=Appelle l'ex\u00e9cution de la phase du cycle de vie <code>{0}</code> avant de s'ex\u00e9cuter. pluginxdoc.mojodescriptor.executePhase=Appelle l'ex\u00e9cution de la phase du cycle de vie <code>{0}</code> avant de s'ex\u00e9cuter.
@ -52,3 +53,4 @@ pluginxdoc.mojodescriptor.requiredParameters=Param\u00e8tres requis
pluginxdoc.mojodescriptor.optionalParameters=Param\u00e8tres optionnels pluginxdoc.mojodescriptor.optionalParameters=Param\u00e8tres optionnels
pluginxdoc.mojodescriptor.parameters=Param\u00e8tres pluginxdoc.mojodescriptor.parameters=Param\u00e8tres
pluginxdoc.mojodescriptor.noParameter=(aucun param\u00e8tre) pluginxdoc.mojodescriptor.noParameter=(aucun param\u00e8tre)
pluginxdoc.mojodescriptor.threadSafe=Le goal est thread-safe et soutient des constructions parall\u00e8les.

View File

@ -352,10 +352,10 @@ public interface JavaMojoAnnotation
String DEPRECATED = "deprecated"; String DEPRECATED = "deprecated";
/** /**
* Indicates that this mojo is threadsafe and can be run in parallel * Indicates that this mojo is thread-safe and can be run in parallel
* *
* <b>Note</b>: Should be defined in a Mojo Type. * <b>Note</b>: Should be defined in a Mojo Type.
*/ */
String THREADSAFE = "threadSafe"; String THREAD_SAFE = "threadSafe";
} }

View File

@ -304,12 +304,19 @@ public class JavaMojoDescriptorExtractor
mojoDescriptor.setDependencyResolutionRequired( v ); mojoDescriptor.setDependencyResolutionRequired( v );
} }
// What version it was introduced in // Dependency collection flag
DocletTag requiresDependencyCollection = DocletTag requiresDependencyCollection =
findInClassHierarchy( javaClass, JavaMojoAnnotation.REQUIRES_DEPENDENCY_COLLECTION ); findInClassHierarchy( javaClass, JavaMojoAnnotation.REQUIRES_DEPENDENCY_COLLECTION );
if ( requiresDependencyCollection != null ) if ( requiresDependencyCollection != null )
{ {
mojoDescriptor.setRequiresDependencyCollection( requiresDependencyCollection.getValue() ); String v = requiresDependencyCollection.getValue();
if ( StringUtils.isEmpty( v ) )
{
v = "runtime";
}
mojoDescriptor.setDependencyCollectionRequired( v );
} }
// requiresDirectInvocation flag // requiresDirectInvocation flag
@ -351,9 +358,9 @@ public class JavaMojoDescriptorExtractor
mojoDescriptor.setSince( since.getValue() ); mojoDescriptor.setSince( since.getValue() );
} }
// Threadsafe mojo // Thread-safe mojo
value = getBooleanTagValue( javaClass, JavaMojoAnnotation.THREADSAFE, true, mojoDescriptor.isThreadSafe() ); value = getBooleanTagValue( javaClass, JavaMojoAnnotation.THREAD_SAFE, true, mojoDescriptor.isThreadSafe() );
mojoDescriptor.setThreadSafe( value ); mojoDescriptor.setThreadSafe( value );
extractParameters( mojoDescriptor, javaClass ); extractParameters( mojoDescriptor, javaClass );
@ -401,14 +408,14 @@ public class JavaMojoDescriptorExtractor
{ {
String value = tag.getValue(); String value = tag.getValue();
if ( StringUtils.isEmpty( value ) ) if ( StringUtils.isNotEmpty( value ) )
{
return defaultForTag;
}
else if ( StringUtils.isNotEmpty( value ) )
{ {
return Boolean.valueOf( value ).booleanValue(); return Boolean.valueOf( value ).booleanValue();
} }
else
{
return defaultForTag;
}
} }
return defaultValue; return defaultValue;
} }

View File

@ -124,8 +124,7 @@ public class JavaMojoDescriptorExtractorTest
ExtendedMojoDescriptor mojoDescriptor = (ExtendedMojoDescriptor) results.get( 0 ); ExtendedMojoDescriptor mojoDescriptor = (ExtendedMojoDescriptor) results.get( 0 );
assertTrue( mojoDescriptor.isThreadSafe() ); assertTrue( mojoDescriptor.isThreadSafe() );
assertEquals( "test", mojoDescriptor.getRequiresDependencyCollection() ); assertEquals( "test", mojoDescriptor.getDependencyCollectionRequired() );
} }
/** /**

View File

@ -25,7 +25,7 @@ import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import java.util.Map; import java.util.Map;
/** /**
* The <tt>@threadSafe</tt> tag is used to indicate that a mojo is threadsafe and can be run in parallel * The <tt>@threadSafe</tt> tag is used to indicate that a mojo is thread-safe and can be run in parallel
* <br/> * <br/>
* The following is a sample declaration: * The following is a sample declaration:
* <pre> * <pre>
@ -43,7 +43,7 @@ import java.util.Map;
* </pre> * </pre>
* <b>Note</b>: This taglet is similar to call the <code>Javadoc</code> tool with the following: * <b>Note</b>: This taglet is similar to call the <code>Javadoc</code> tool with the following:
* <pre> * <pre>
* javadoc ... -tag 'threadSafe:t:Indicates the mojo is threadsafe' * javadoc ... -tag 'threadSafe:t:Indicates the mojo is thread-safe'
* </pre> * </pre>
* *
* @see <a href="package-summary.html#package_description">package-summary.html</a> * @see <a href="package-summary.html#package_description">package-summary.html</a>
@ -55,7 +55,7 @@ public class MojoThreadSafeTypeTaglet
extends AbstractMojoTypeTaglet extends AbstractMojoTypeTaglet
{ {
/** The Javadoc annotation */ /** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.THREADSAFE; private static final String NAME = JavaMojoAnnotation.THREAD_SAFE;
/** The Javadoc text which will be added to the generated page. */ /** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Mojo is thread safe"; protected static final String HEADER = "Mojo is thread safe";