@ExportedBean public class ObjectMetadataAction extends InvisibleAction implements Serializable
SCMRevision
, SCMHead
, SCMSource
or
SCMNavigator
.
For example:
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 nameSCMSource
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 nameSCMHead
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
Constructor and Description |
---|
ObjectMetadataAction(String objectDisplayName,
String objectDescription,
String objectUrl) |
Modifier and Type | Method and 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() |
getDisplayName, getIconFileName, getUrlName
@Exported @CheckForNull public String getObjectDisplayName()
null
. Consumers should assume the content is plain text that
needs escaping with Util.escape(String)
when being included in HTML output.null
@Exported @CheckForNull public String getObjectDescription()
null
. Consumers should assume the content is plain text that
needs escaping with Util.escape(String)
when being included in HTML output.null
.@Exported @CheckForNull public String getObjectUrl()
null
if the object does not have an external url.null
Copyright © 2016–2022. All rights reserved.