Package hudson.maven.reporters

Class MavenJavadocArchiver

java.lang.Object

hudson.maven.MavenReporter

hudson.maven.reporters.AbstractMavenJavadocArchiver

hudson.maven.reporters.MavenJavadocArchiver

All Implemented Interfaces:

ExtensionPoint, MavenProjectActionBuilder, Describable<MavenReporter>, Serializable

public class MavenJavadocArchiver
extends AbstractMavenJavadocArchiver

Records the javadoc and archives it.

Author:

Kohsuke Kawaguchi

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MavenJavadocArchiver.DescriptorImpl

Nested classes/interfaces inherited from class hudson.maven.reporters.AbstractMavenJavadocArchiver

AbstractMavenJavadocArchiver.MavenJavadocAction

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
MavenJavadocArchiver()

Method Summary

Modifier and Type	Method	Description
boolean	checkIsJavadocMojo(MojoInfo mojo)	return true if this mojo is a javadoc one sources or test sources
Action	getAggregatedProjectAction(MavenModuleSet project)	Works like MavenReporter.getProjectAction(MavenModule) but works at MavenModuleSet level.
String	getArchiveTargetPath()
Collection<? extends Action>	getProjectActions(MavenModule project)	Equivalent of BuildStep.getProjectActions(AbstractProject) for MavenReporter.

Methods inherited from class hudson.maven.reporters.AbstractMavenJavadocArchiver

getTarget, postExecute, reportGenerated

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

MavenJavadocArchiver

public MavenJavadocArchiver()

Method Details

getProjectActions

public 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

Specified by:

getProjectActions in class AbstractMavenJavadocArchiver

Returns:

can be empty but never null.

getArchiveTargetPath

public String getArchiveTargetPath()

Specified by:

getArchiveTargetPath in class AbstractMavenJavadocArchiver

getAggregatedProjectAction

public 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.

Specified by:

getAggregatedProjectAction in class AbstractMavenJavadocArchiver

Returns:

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

checkIsJavadocMojo

public boolean checkIsJavadocMojo(MojoInfo mojo)

Description copied from class: AbstractMavenJavadocArchiver

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

Specified by:

checkIsJavadocMojo in class AbstractMavenJavadocArchiver

Parameters:

mojo - the Mojo to check

Returns:

true if the Mojo runs javadoc