hudson.tasks

Class JavadocArchiver

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

hudson.tasks.JavadocArchiver

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

public class JavadocArchiver
extends hudson.tasks.Recorder

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 and Description
protected static class	JavadocArchiver.BaseJavadocAction
static class	JavadocArchiver.DescriptorImpl
static class	JavadocArchiver.JavadocAction
static class	JavadocArchiver.JavadocBuildAction

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
JavadocArchiver(String javadocDir, boolean keepAll)

Method Summary

Methods

Modifier and Type	Method and Description
String	getJavadocDir()
Collection<hudson.model.Action>	getProjectActions(hudson.model.AbstractProject project)
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
boolean	isKeepAll()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)

Methods inherited from class hudson.tasks.Recorder

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, prebuild

Constructor Detail

JavadocArchiver

@DataBoundConstructor
public JavadocArchiver(String javadocDir,
                                    boolean keepAll)

Method Detail

getJavadocDir

public String getJavadocDir()

isKeepAll

public boolean isKeepAll()

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
              hudson.Launcher launcher,
              hudson.model.BuildListener listener)
                throws InterruptedException,
                       IOException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException

getProjectActions

public Collection<hudson.model.Action> getProjectActions(hudson.model.AbstractProject project)

Specified by:

getProjectActions in interface hudson.tasks.BuildStep

Overrides:

getProjectActions in class hudson.tasks.BuildStepCompatibilityLayer

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()