Package org.jvnet.maven.jellydoc

Class JellydocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jvnet.maven.jellydoc.JellydocMojo

All Implemented Interfaces:

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

@Mojo(name="jellydoc",
      requiresDependencyResolution=COMPILE)
@Execute(phase=GENERATE_SOURCES)
public class JellydocMojo
extends org.apache.maven.plugin.AbstractMojo
implements org.apache.maven.reporting.MavenMultiPageReport

Generates jellydoc XML and other artifacts from there.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
org.apache.maven.artifact.factory.ArtifactFactory	factory	Factory for creating artifact objects
org.apache.maven.project.MavenProjectHelper	helper
List<org.apache.maven.artifact.Artifact>	pluginArtifacts	The plugin dependencies.
String	pluginVersion	Version of this plugin.
org.apache.maven.project.MavenProject	project	The Maven Project Object
org.eclipse.aether.RepositorySystem	repositorySystem	Used for resolving artifacts
org.apache.maven.execution.MavenSession	session	The Maven session object.

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	Description
JellydocMojo()

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()
void	execute()
void	generate(org.apache.maven.doxia.sink.Sink sink, Locale locale)	Deprecated. use generate(Sink, SinkFactory, Locale) instead.
void	generate(org.apache.maven.doxia.sink.Sink sink, org.apache.maven.doxia.sink.SinkFactory sinkFactory, Locale locale)	This method is called when the report generation is invoked by maven-site-plugin.
void	generateSchema()
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
File	getReportOutputDirectory()
boolean	isExternalReport()
void	setReportOutputDirectory(File outputDirectory)

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

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

getOutputPath

Field Details

project

@Parameter(defaultValue="${project}",
           required=true,
           readonly=true)
public org.apache.maven.project.MavenProject project

The Maven Project Object

session

@Parameter(defaultValue="${session}",
           required=true,
           readonly=true)
public org.apache.maven.execution.MavenSession session

The Maven session object.

pluginArtifacts

@Parameter(defaultValue="${plugin.artifacts}",
           required=true,
           readonly=true)
public List<org.apache.maven.artifact.Artifact> pluginArtifacts

The plugin dependencies.

pluginVersion

@Parameter(defaultValue="${plugin.version}",
           required=true,
           readonly=true)
public String pluginVersion

Version of this plugin.

factory

@Component
public org.apache.maven.artifact.factory.ArtifactFactory factory

Factory for creating artifact objects

repositorySystem

@Component
public org.eclipse.aether.RepositorySystem repositorySystem

Used for resolving artifacts

helper

@Component
public org.apache.maven.project.MavenProjectHelper helper

Constructor Details

JellydocMojo

public JellydocMojo()

Method Details

execute

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

Specified by:

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

Throws:

org.apache.maven.plugin.MojoExecutionException

generateSchema

public void generateSchema()
                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

generate

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

Deprecated.

use generate(Sink, SinkFactory, Locale) instead.

Generate a report.

Specified by:

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

Parameters:

sink - The sink to use for the generation.

locale - The desired locale in which to generate the report; could be null.

Throws:

org.apache.maven.reporting.MavenReportException - if any error occurs

generate

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

This method is called when the report generation is invoked by maven-site-plugin.

Specified by:

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

Parameters:

sink - The sink to use for the generation.

sinkFactory - The sink factory to use for the generation; could be null.

locale - The desired locale in which to generate the report; could be null.

Throws:

org.apache.maven.reporting.MavenReportException - if any error occurs

getOutputName

public String getOutputName()

Specified by:

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

getName

public String getName(Locale locale)

Specified by:

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

getCategoryName

public String getCategoryName()

Specified by:

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

getDescription

public String getDescription(Locale locale)

Specified by:

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

setReportOutputDirectory

public void setReportOutputDirectory(File outputDirectory)

Specified by:

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

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

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

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