Package jenkins.scm.api.metadata

Class ContributorMetadataAction

java.lang.Object

hudson.model.InvisibleAction

jenkins.scm.api.metadata.ContributorMetadataAction

All Implemented Interfaces:

Action, ModelObject, Serializable

@ExportedBean
public class ContributorMetadataAction
extends InvisibleAction
implements Serializable

Holds metadata about the contributor of a SCMRevision, SCMHead, SCMSource or SCMNavigator.

In general we expect this to be reported from SCMSource.fetchActions(SCMHead, SCMHeadEvent, TaskListener) for ChangeRequestSCMHead instances but can be used elsewhere where that makes sense.

Since:

2.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ContributorMetadataAction(String contributor, String contributorDisplayName, String contributorEmail)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getContributor()	Username of author of the proposed change.
String	getContributorDisplayName()	Human name of author of proposed change.
String	getContributorEmail()	Email address of author of proposed change.
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 Detail

ContributorMetadataAction

public ContributorMetadataAction(String contributor,
                                 String contributorDisplayName,
                                 String contributorEmail)

Method Detail

getContributor

@Exported
@CheckForNull
public String getContributor()

Username of author of the proposed change.

Returns:

a user login name or other unique user identifier

getContributorDisplayName

@Exported
@CheckForNull
public String getContributorDisplayName()

Human name of author of proposed change.

Returns:

First M. Last, etc.

getContributorEmail

@Exported
@CheckForNull
public String getContributorEmail()

Email address of author of proposed change.

Returns:

a valid email address

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