Package hudson.maven.reporters

Class AbstractMavenJavadocArchiver

java.lang.Object

hudson.maven.MavenReporter

hudson.maven.reporters.AbstractMavenJavadocArchiver

All Implemented Interfaces:

ExtensionPoint, MavenProjectActionBuilder, Describable<MavenReporter>, Serializable

Direct Known Subclasses:

MavenJavadocArchiver, MavenTestJavadocArchiver

public abstract class AbstractMavenJavadocArchiver
extends MavenReporter

Records the javadoc and archives it.

Author:

Kohsuke Kawaguchi

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractMavenJavadocArchiver.MavenJavadocAction

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
AbstractMavenJavadocArchiver()

Method Summary

Modifier and Type	Method	Description
abstract boolean	checkIsJavadocMojo(MojoInfo mojo)	return true if this mojo is a javadoc one sources or test sources
abstract Action	getAggregatedProjectAction(MavenModuleSet project)	Works like MavenReporter.getProjectAction(MavenModule) but works at MavenModuleSet level.
abstract String	getArchiveTargetPath()
abstract Collection<? extends Action>	getProjectActions(MavenModule project)	Equivalent of BuildStep.getProjectActions(AbstractProject) for MavenReporter.
protected final FilePath	getTarget(AbstractMavenProject<?,?> project)
boolean	postExecute(MavenBuildProxy build, org.apache.maven.project.MavenProject pom, MojoInfo mojo, BuildListener listener, Throwable error)	Called after execution of a single mojo.
boolean	reportGenerated(MavenBuildProxy build, org.apache.maven.project.MavenProject pom, MavenReportInfo report, BuildListener listener)	Called after a MavenReport is successfully generated.

Methods inherited from class hudson.maven.MavenReporter

end, enterModule, getDescriptor, getProjectAction, leaveModule, postBuild, preBuild, preExecute

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractMavenJavadocArchiver

public AbstractMavenJavadocArchiver()

Method Details

checkIsJavadocMojo

public abstract boolean checkIsJavadocMojo(MojoInfo mojo)

return true if this mojo is a javadoc one sources or test sources

Parameters:

mojo - the Mojo to check

Returns:

true if the Mojo runs javadoc

getArchiveTargetPath

public abstract String getArchiveTargetPath()

postExecute

public boolean postExecute(MavenBuildProxy build,
 org.apache.maven.project.MavenProject pom,
 MojoInfo mojo,
 BuildListener listener,
 Throwable error)
                    throws InterruptedException,
IOException

Description copied from class: MavenReporter

Called after execution of a single mojo.

See MavenReporter.preExecute(hudson.maven.MavenBuildProxy, org.apache.maven.project.MavenProject, hudson.maven.MojoInfo, hudson.model.BuildListener) for the contract.

Overrides:

postExecute in class MavenReporter

error - If mojo execution failed with MojoFailureException or MojoExecutionException, this method is still invoked with those error objects. If mojo executed successfully, this parameter is null.

Throws:

InterruptedException

IOException

reportGenerated

public boolean reportGenerated(MavenBuildProxy build,
 org.apache.maven.project.MavenProject pom,
 MavenReportInfo report,
 BuildListener listener)
                        throws InterruptedException,
IOException

Description copied from class: MavenReporter

Called after a MavenReport is successfully generated.

MavenReport is an execution unit inside the Maven site plugin mojos, such as site:generate. These are what's configured through <reporting> tag inside POM, although there's normally more MavenReports than what's specified explicitly, due to defaulting and inheritance and all the other Maven processing.

This provides an opportunity for plugins to auto-perform some action when a certain reporting is generated.

This method is invoked during the execution of site mojos, between its MavenReporter.preExecute(MavenBuildProxy, MavenProject, MojoInfo, BuildListener) and MavenReporter.postExecute(MavenBuildProxy, MavenProject, MojoInfo, BuildListener, Throwable)

Overrides:

reportGenerated in class MavenReporter

Returns:

See MavenReporter.preBuild(hudson.maven.MavenBuildProxy, org.apache.maven.project.MavenProject, hudson.model.BuildListener)

Throws:

InterruptedException - See MavenReporter.preBuild(hudson.maven.MavenBuildProxy, org.apache.maven.project.MavenProject, hudson.model.BuildListener)

IOException - See MavenReporter.preBuild(hudson.maven.MavenBuildProxy, org.apache.maven.project.MavenProject, hudson.model.BuildListener)

getProjectActions

public abstract Collection<? extends Action> getProjectActions(MavenModule project)

Description copied from class: MavenReporter

Equivalent of BuildStep.getProjectActions(AbstractProject) for MavenReporter.

Registers a transient action to MavenModule when it's rendered. This is useful if you'd like to display an action at the module level.

Since this contributes a transient action, the returned Action will not be serialized.

For this method to be invoked, your MavenReporter has to invoke MavenBuildProxy.registerAsProjectAction(MavenReporter) during the build.

Specified by:

getProjectActions in interface MavenProjectActionBuilder

Overrides:

getProjectActions in class MavenReporter

Returns:

can be empty but never null.

getAggregatedProjectAction

public abstract Action getAggregatedProjectAction(MavenModuleSet project)

Description copied from class: MavenReporter

Works like MavenReporter.getProjectAction(MavenModule) but works at MavenModuleSet level.

For this method to be invoked, your MavenReporter has to invoke MavenBuildProxy.registerAsAggregatedProjectAction(MavenReporter) during the build.

Overrides:

getAggregatedProjectAction in class MavenReporter

Returns:

null not to contribute an action, which is the default.

getTarget

protected final FilePath getTarget(AbstractMavenProject<?,?> project)