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
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract boolean
checkIsJavadocMojo(MojoInfo mojo)
return true if this mojo is a javadoc one sources or test sourcesabstract Action
getAggregatedProjectAction(MavenModuleSet project)
Works likeMavenReporter.getProjectAction(MavenModule)
but works atMavenModuleSet
level.abstract String
getArchiveTargetPath()
abstract Collection<? extends Action>
getProjectActions(MavenModule project)
Equivalent ofBuildStep.getProjectActions(AbstractProject)
forMavenReporter
.protected 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 aMavenReport
is successfully generated.-
Methods inherited from class hudson.maven.MavenReporter
end, enterModule, getDescriptor, getProjectAction, leaveModule, postBuild, preBuild, preExecute
-
-
-
-
Method Detail
-
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 classMavenReporter
error
- If mojo execution failed withMojoFailureException
orMojoExecutionException
, 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 aMavenReport
is successfully generated.MavenReport
is an execution unit inside the Maven site plugin mojos, such assite:generate
. These are what's configured through<reporting>
tag inside POM, although there's normally moreMavenReport
s 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)
andMavenReporter.postExecute(MavenBuildProxy, MavenProject, MojoInfo, BuildListener, Throwable)
- Overrides:
reportGenerated
in classMavenReporter
- Returns:
- See
MavenReporter.preBuild(hudson.maven.MavenBuildProxy, org.apache.maven.project.MavenProject, hudson.model.BuildListener)
- Throws:
InterruptedException
- SeeMavenReporter.preBuild(hudson.maven.MavenBuildProxy, org.apache.maven.project.MavenProject, hudson.model.BuildListener)
IOException
- SeeMavenReporter.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 ofBuildStep.getProjectActions(AbstractProject)
forMavenReporter
.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 invokeMavenBuildProxy.registerAsProjectAction(MavenReporter)
during the build.- Specified by:
getProjectActions
in interfaceMavenProjectActionBuilder
- Overrides:
getProjectActions
in classMavenReporter
- Returns:
- can be empty but never null.
-
getAggregatedProjectAction
public abstract Action getAggregatedProjectAction(MavenModuleSet project)
Description copied from class:MavenReporter
Works likeMavenReporter.getProjectAction(MavenModule)
but works atMavenModuleSet
level.For this method to be invoked, your
MavenReporter
has to invokeMavenBuildProxy.registerAsAggregatedProjectAction(MavenReporter)
during the build.- Overrides:
getAggregatedProjectAction
in classMavenReporter
- Returns:
- null not to contribute an action, which is the default.
-
getTarget
protected final FilePath getTarget(AbstractMavenProject<?,?> project)
-
-