org.apache.camel.maven

Class DocumentGeneratorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.camel.maven.AbstractGeneratorMojo

org.apache.camel.maven.DocumentGeneratorMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

@Mojo(name="document",
      requiresDependencyResolution=COMPILE,
      requiresProject=true,
      defaultPhase=SITE)
public class DocumentGeneratorMojo
extends AbstractGeneratorMojo
implements org.apache.maven.reporting.MavenReport

Generates documentation for API Component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentGeneratorMojo.EndpointInfo

Field Summary

Fields inherited from class org.apache.camel.maven.AbstractGeneratorMojo

COMPONENT_PACKAGE, componentName, componentPackage, log, OUT_PACKAGE, outPackage, PREFIX, project, scheme

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
DocumentGeneratorMojo()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
void	execute()
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
static String	getCanonicalName(Field field)
String	getCategoryName()
String	getDescription(Locale locale)
String	getDestDir()
static List<DocumentGeneratorMojo.EndpointInfo>	getEndpoints(Class<? extends org.apache.camel.util.component.ApiMethod> apiMethod, org.apache.camel.util.component.ApiMethodHelper<?> helper, Class<?> endpointConfig)
String	getName(Locale locale)
String	getOutputName()
File	getReportOutputDirectory()
boolean	isExternalReport()
void	setDescription(String description)
void	setDestDir(String destDir)
void	setName(String name)
void	setReportOutputDirectory(File reportOutputDirectory)

Methods inherited from class org.apache.camel.maven.AbstractGeneratorMojo

clearSharedProjectState, getCanonicalName, getEngine, getProjectClassLoader, mergeTemplate, setSharedProjectState

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentGeneratorMojo

public DocumentGeneratorMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
            Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Specified by:

generate in interface org.apache.maven.reporting.MavenReport

Throws:

org.apache.maven.reporting.MavenReportException

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface org.apache.maven.reporting.MavenReport

setName

public void setName(String name)

getName

public String getName(Locale locale)

Specified by:

getName in interface org.apache.maven.reporting.MavenReport

setDescription

public void setDescription(String description)

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

getDestDir

public String getDestDir()

setDestDir

public void setDestDir(String destDir)

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

getEndpoints

public static List<DocumentGeneratorMojo.EndpointInfo> getEndpoints(Class<? extends org.apache.camel.util.component.ApiMethod> apiMethod,
                                                    org.apache.camel.util.component.ApiMethodHelper<?> helper,
                                                    Class<?> endpointConfig)

getCanonicalName

public static String getCanonicalName(Field field)