Package hudson.model

Class CauseAction

java.lang.Object

hudson.model.CauseAction

All Implemented Interfaces:

Action, ModelObject, FoldableAction, RunAction2

@ExportedBean
public class CauseAction
extends Object
implements FoldableAction, RunAction2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CauseAction.ConverterImpl

Constructor Summary

Constructors

Constructor	Description
CauseAction(Cause c)
CauseAction(Cause... c)
CauseAction(CauseAction ca)
CauseAction(Collection<? extends Cause> causes)

Method Summary

Modifier and Type	Method	Description
<T extends Cause> T	findCause(Class<T> type)	Finds the cause of the specific type.
void	foldIntoExisting(Queue.Item item, Queue.Task owner, List<Action> otherActions)	Notifies that the Queue.Task that "owns" this action (that is, the task for which this action is submitted) is considered as a duplicate.
Map<Cause,Integer>	getCauseCounts()	Get list of causes with duplicates combined into counters.
List<Cause>	getCauses()	Lists all causes of this build.
String	getDisplayName()	Gets the string to be displayed.
String	getIconFileName()	Gets the name of the icon.
String	getShortDescription()	Deprecated. as of 1.288 but left here for backward compatibility.
String	getUrlName()	Gets the URL path name.
void	onAttached(Run<?,?> owner)	When hooked up to build, notify Causes.
void	onLoad(Run<?,?> owner)	Called after a build is loaded to which this action was previously attached.

Methods inherited from class java.lang.Object

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

Constructor Detail

CauseAction

public CauseAction(Cause c)

CauseAction

public CauseAction(Cause... c)

CauseAction

public CauseAction(Collection<? extends Cause> causes)

CauseAction

public CauseAction(CauseAction ca)

Method Detail

getCauses

@Exported(visibility=2)
public List<Cause> getCauses()

Lists all causes of this build. Note that the current implementation does not preserve insertion order of duplicates.

Returns:

an immutable list; to create an action with multiple causes use either of the constructors that support this; to append causes retroactively to a build you must create a new CauseAction and replace the old

findCause

public <T extends Cause> T findCause(Class<T> type)

Finds the cause of the specific type.

getDisplayName

public String getDisplayName()

Description copied from interface: Action

Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

Returns:

Can be null in case the action is hidden.

getIconFileName

public String getIconFileName()

Description copied from interface: Action

Gets the name of the icon.

Specified by:

getIconFileName in interface Action

Returns:

If the icon name is prefixed with "symbol-", a Jenkins Symbol will be used.

If just a file name (like "abc.gif") is returned, it will be interpreted as a file name inside /images/24x24. This is useful for using one of the stock images.

If an absolute file name that starts from '/' is returned (like "/plugin/foo/abc.gif"), then it will be interpreted as a path from the context root of Jenkins. This is useful to pick up image files from a plugin.

Finally, return null to hide it from the task list. This is normally not very useful, but this can be used for actions that only contribute floatBox.jelly and no task list item. The other case where this is useful is to avoid showing links that require a privilege when the user is anonymous.

See Also:

Jenkins Symbols, Functions.isAnonymous(), Functions.getIconFilePath(Action)

getUrlName

public String getUrlName()

Description copied from interface: Action

Gets the URL path name.

For example, if this method returns "xyz", and if the parent object (that this action is associated with) is bound to /foo/bar/zot, then this action object will be exposed to /foo/bar/zot/xyz.

This method should return a string that's unique among other Actions.

The returned string can be an absolute URL, like "http://www.sun.com/", which is useful for directly connecting to external systems.

If the returned string starts with '/', like '/foo', then it's assumed to be relative to the context path of the Jenkins webapp.

Specified by:

getUrlName in interface Action

Returns:

null if this action object doesn't need to be bound to web (when you do that, be sure to also return null from Action.getIconFileName().

See Also:

Functions.getActionUrl(String, Action)

getCauseCounts

public Map<Cause,Integer> getCauseCounts()

Get list of causes with duplicates combined into counters.

Returns:

Map of Cause to number of occurrences of that Cause

getShortDescription

@Deprecated
public String getShortDescription()

Deprecated.

as of 1.288 but left here for backward compatibility.

onLoad

public void onLoad(Run<?,?> owner)

Description copied from interface: RunAction2

Called after a build is loaded to which this action was previously attached.

Specified by:

onLoad in interface RunAction2

onAttached

public void onAttached(Run<?,?> owner)

When hooked up to build, notify Causes.

Specified by:

onAttached in interface RunAction2

foldIntoExisting

public void foldIntoExisting(Queue.Item item,
                             Queue.Task owner,
                             List<Action> otherActions)

Description copied from interface: FoldableAction

Notifies that the Queue.Task that "owns" this action (that is, the task for which this action is submitted) is considered as a duplicate.

Specified by:

foldIntoExisting in interface FoldableAction

Parameters:

item - The existing Queue.Item in the queue against which we are judged as a duplicate. Never null.

owner - The Queue.Task with which this action was submitted to the queue. Never null.

otherActions - Other Actions that are submitted with the task. (One of them is this FoldableAction.) Never null.