@ExportedBean public class CauseAction extends Object implements FoldableAction, RunAction2
Modifier and Type | Class and Description |
---|---|
static class |
CauseAction.ConverterImpl |
Constructor and Description |
---|
CauseAction(Cause... c) |
CauseAction(Cause c) |
CauseAction(CauseAction ca) |
CauseAction(Collection<? extends Cause> causes) |
Modifier and Type | Method and Description |
---|---|
<T extends Cause> |
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 file 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
Cause s. |
void |
onLoad(Run<?,?> owner)
Called after a build is loaded to which this action was previously attached.
|
public CauseAction(Cause c)
public CauseAction(Cause... c)
public CauseAction(Collection<? extends Cause> causes)
public CauseAction(CauseAction ca)
@Exported(visibility=2) public List<Cause> getCauses()
CauseAction
and replace the oldpublic String getDisplayName()
Action
getDisplayName
in interface Action
getDisplayName
in interface ModelObject
public String getIconFileName()
Action
getIconFileName
in interface Action
/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.
Functions.isAnonymous()
,
Functions.getIconFilePath(Action)
public String getUrlName()
Action
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 Action
s.
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.
getUrlName
in interface Action
Action.getIconFileName()
.Functions.getActionUrl(String, Action)
public Map<Cause,Integer> getCauseCounts()
@Deprecated public String getShortDescription()
public void onLoad(Run<?,?> owner)
RunAction2
onLoad
in interface RunAction2
public void onAttached(Run<?,?> owner)
Cause
s.onAttached
in interface RunAction2
public void foldIntoExisting(Queue.Item item, Queue.Task owner, List<Action> otherActions)
FoldableAction
Queue.Task
that "owns" this action (that is, the task for which this action is submitted)
is considered as a duplicate.foldIntoExisting
in interface FoldableAction
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 Action
s that are submitted with the task. (One of them is this FoldableAction
.)
Never null.Copyright © 2004–2021. All rights reserved.