Package hudson.plugins.doclinks.artifacts

Class ArtifactsDocsLinksActionBase

java.lang.Object

hudson.plugins.doclinks.artifacts.ArtifactsDocsLinksActionBase

All Implemented Interfaces:

Action, ModelObject

Direct Known Subclasses:

ArtifactsDocLinksAction, ArtifactsDocLinksProjectAction

public abstract class ArtifactsDocsLinksActionBase
extends Object
implements Action

Common base class for ArtifactsDocLinksAction and ArtifactsDocLinksProjectAction.

Field Summary

Fields

Modifier and Type	Field	Description
static String	URLNAME	URL for this action.

Constructor Summary

Constructors

Constructor	Description
ArtifactsDocsLinksActionBase()

Method Summary

Modifier and Type	Method	Description
AbstractBuild<?,?>	getBuild(org.kohsuke.stapler.StaplerRequest req)	Returns the build that have artifacts this action handles.
String	getIconFileName()	Returns the name of an icon used in the side menu.
AbstractBuild<?,?>	getLastDocumentedBuild(AbstractProject<?,?> project)	Returns the last build with artifact documents in a project.
Object	getOwner(org.kohsuke.stapler.StaplerRequest req)	Returns the container of this action.
AbstractProject<?,?>	getProject(org.kohsuke.stapler.StaplerRequest req)
String	getUrlName()	Returns an URL to access this action.

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Action

getDisplayName

Field Detail

URLNAME

public static final String URLNAME

URL for this action.

See Also:

Constant Field Values

Constructor Detail

ArtifactsDocsLinksActionBase

public ArtifactsDocsLinksActionBase()

Method Detail

getOwner

public Object getOwner(org.kohsuke.stapler.StaplerRequest req)

Returns the container of this action.

Parameters:

req - StaplerRequest used for access this action.

Returns:

AbstractProject or AbstractBuild.

getProject

public AbstractProject<?,?> getProject(org.kohsuke.stapler.StaplerRequest req)

Parameters:

req -

Returns:

the project containing this action

getBuild

public AbstractBuild<?,?> getBuild(org.kohsuke.stapler.StaplerRequest req)

Returns the build that have artifacts this action handles. If called in a project context, returns the last build that contains artifact documents.

Parameters:

req -

Returns:

the build with document artifacts to handle.

getLastDocumentedBuild

public AbstractBuild<?,?> getLastDocumentedBuild(AbstractProject<?,?> project)

Returns the last build with artifact documents in a project.

Parameters:

project -

Returns:

a build with artifact documents.

getIconFileName

public String getIconFileName()

Returns the name of an icon used in the side menu.

Specified by:

getIconFileName in interface Action

Returns:

See Also:

Action.getIconFileName()

getUrlName

public String getUrlName()

Returns an URL to access this action. This URL is relative from the owner object.

Specified by:

getUrlName in interface Action

Returns:

See Also:

Action.getUrlName()