Class JavadocArchiver

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

hudson.tasks.JavadocArchiver

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class JavadocArchiver
extends Recorder
implements SimpleBuildStep

Saves Javadoc for the project and publish them. This class is in a wrong package for a historical reason.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	JavadocArchiver.BaseJavadocAction
static class	JavadocArchiver.DescriptorImpl
static class	JavadocArchiver.JavadocAction
static class	JavadocArchiver.JavadocBuildAction

Nested classes/interfaces inherited from class Publisher

Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields inherited from interface BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
JavadocArchiver(String javadocDir, boolean keepAll)

Method Summary

Modifier and Type	Method	Description
String	getJavadocDir()
BuildStepMonitor	getRequiredMonitorService()
boolean	isKeepAll()
void	perform(Run<?,?> build, FilePath workspace, Launcher launcher, TaskListener listener)

Methods inherited from class Recorder

getDescriptor

Methods inherited from class Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class Object

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

Methods inherited from interface BuildStep

getProjectAction, getProjectActions, perform, prebuild

Methods inherited from interface SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Details

JavadocArchiver

@DataBoundConstructor
public JavadocArchiver(String javadocDir,
 boolean keepAll)

Method Details

getJavadocDir

public String getJavadocDir()

isKeepAll

public boolean isKeepAll()

perform

public void perform(Run<?,?> build,
 FilePath workspace,
 Launcher launcher,
 TaskListener listener)
             throws InterruptedException,
IOException

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep