Package jenkins.scm.api.metadata

Class ObjectMetadataAction

java.lang.Object

hudson.model.InvisibleAction

jenkins.scm.api.metadata.ObjectMetadataAction

All Implemented Interfaces:

Action, ModelObject, Serializable

@ExportedBean
public class ObjectMetadataAction
extends InvisibleAction
implements Serializable

Holds metadata about the object referenced by a SCMRevision, SCMHead, SCMSource or SCMNavigator.

For example:

• A SCMNavigator implementation that corresponds to a GitHub Team could use the getObjectUrl() to point to the GitHub Team page, and the getObjectDisplayName() to provide the team name
• A SCMSource implementation that corresponds to a GitHub Repository could use the getObjectUrl() to point to the GitHub repository, and the getObjectDescription() to provide the repository description name
• A SCMHead implementation that corresponds to a GitHub Pull Request could use the getObjectUrl() to point to the pull request on GitHub, the getObjectDisplayName() to provide the title of the pull request and getObjectDescription() to provide the description of the pull request

Since:

2.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ObjectMetadataAction(String objectDisplayName, String objectDescription, String objectUrl)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getObjectDescription()	Returns the description of the object or null.
String	getObjectDisplayName()	Returns the display name of the object or null.
String	getObjectUrl()	Returns the external url of the object or null if the object does not have an external url.
int	hashCode()
String	toString()

Methods inherited from class hudson.model.InvisibleAction

getDisplayName, getIconFileName, getUrlName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ObjectMetadataAction

public ObjectMetadataAction(@CheckForNull
 String objectDisplayName,
 @CheckForNull
 String objectDescription,
 @CheckForNull
 String objectUrl)

Method Details

getObjectDisplayName

@Exported
@CheckForNull
public String getObjectDisplayName()

Returns the display name of the object or null. Consumers should assume the content is plain text that needs escaping with Util.escape(String) when being included in HTML output.

Returns:

the display name of the object or null

getObjectDescription

@Exported
@CheckForNull
public String getObjectDescription()

Returns the description of the object or null. Consumers should assume the content is plain text that needs escaping with Util.escape(String) when being included in HTML output.

Returns:

the description of the object or null.

getObjectUrl

@Exported
@CheckForNull
public String getObjectUrl()

Returns the external url of the object or null if the object does not have an external url.

Returns:

the display name of the object or null

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object