org.apache.maven.tools.plugin.generator
Class PluginDescriptorGenerator

java.lang.Object
  extended by org.apache.maven.tools.plugin.generator.PluginDescriptorGenerator
All Implemented Interfaces:
Generator

public class PluginDescriptorGenerator
extends Object
implements Generator

Generate a Maven Plugin Descriptor XML file and corresponding plugin-help.xml help content for PluginHelpGenerator.

Version:
$Id: PluginDescriptorGenerator.java 1406615 2012-11-07 13:26:25Z krosenvold $

Constructor Summary
PluginDescriptorGenerator(org.apache.maven.plugin.logging.Log log)
           
 
Method Summary
 void execute(File destinationDirectory, PluginToolsRequest request)
          Execute the generation for a given plugin descriptor.
protected  void processMojoDescriptor(MojoDescriptor mojoDescriptor, XMLWriter w)
           
protected  void processMojoDescriptor(MojoDescriptor mojoDescriptor, XMLWriter w, boolean helpDescriptor)
           
 void writeDescriptor(File destinationFile, PluginToolsRequest request, boolean helpDescriptor)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PluginDescriptorGenerator

public PluginDescriptorGenerator(org.apache.maven.plugin.logging.Log log)
Method Detail

execute

public void execute(File destinationDirectory,
                    PluginToolsRequest request)
             throws GeneratorException
Execute the generation for a given plugin descriptor.

Specified by:
execute in interface Generator
Parameters:
destinationDirectory - required
request - required
Throws:
GeneratorException

writeDescriptor

public void writeDescriptor(File destinationFile,
                            PluginToolsRequest request,
                            boolean helpDescriptor)
                     throws IOException,
                            DuplicateMojoDescriptorException
Throws:
IOException
DuplicateMojoDescriptorException

processMojoDescriptor

protected void processMojoDescriptor(MojoDescriptor mojoDescriptor,
                                     XMLWriter w)

processMojoDescriptor

protected void processMojoDescriptor(MojoDescriptor mojoDescriptor,
                                     XMLWriter w,
                                     boolean helpDescriptor)
Parameters:
mojoDescriptor - not null
w - not null
helpDescriptor - will clean html content from description fields


Copyright © 2004-2012 The Apache Software Foundation. All Rights Reserved.