Package jenkins.model.details

Class Detail

java.lang.Object

jenkins.model.details.Detail

All Implemented Interfaces:

ModelObject, IconSpec

Direct Known Subclasses:

DurationDetail, TimestampDetail

public abstract class Detail
extends Object
implements ModelObject, IconSpec

Detail represents a piece of information about a Run. Such information could include:

• the date and time the run started
• the amount of time the run took to complete
• SCM information for the build
• who kicked the build off

Since:

TODO

Constructor Summary

Constructors

Constructor	Description
Detail(Actionable object)

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()
DetailGroup	getGroup()
String	getIconClassName()	Get the Icon class specification e.g.
String	getLink()	Optional URL for the Detail.
Actionable	getObject()
int	getOrder()

Methods inherited from class java.lang.Object

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

Constructor Details

Detail

public Detail(Actionable object)

Method Details

getObject

public Actionable getObject()

getIconClassName

@Nullable
public String getIconClassName()

Get the Icon class specification e.g. 'icon-notepad'.
Note: do NOT include icon size specifications (such as 'icon-sm').

Specified by:

getIconClassName in interface IconSpec

Returns:

The Icon class specification e.g. 'icon-notepad'.

getDisplayName

@Nullable
public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

getLink

@Nullable
public String getLink()

Optional URL for the Detail. If provided the detail element will be a link instead of plain text.

getGroup

public DetailGroup getGroup()

Returns:

the grouping of the detail

getOrder

public int getOrder()

Returns:

order in the group, zero is first, MAX_VALUE is any order