com.atlassian.jira.issue.changehistory.metadata

Class HistoryMetadataParticipant

java.lang.Object

com.atlassian.jira.issue.changehistory.metadata.HistoryMetadataParticipant

@ExperimentalApi
public final class HistoryMetadataParticipant
extends Object

Represents a identifiable participant in the metadata history. This might be a remote system, an event that caused the change to occur, or a user on a remote system.

Since:

JIRA 6.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HistoryMetadataParticipant.HistoryMetadataParticipantBuilder

Method Summary

Modifier and Type	Method and Description
static HistoryMetadataParticipant.HistoryMetadataParticipantBuilder	builder(String id, String type)
boolean	equals(Object obj) This method is implemented for usage in Unit Tests.
String	getAvatarUrl() The avatar image url of the participant
String	getDisplayName() The user readable name of the participant
String	getDisplayNameKey() i18n key for the user readable name of the participant, will be used before displayName if present
String	getId() The identifier of this participant
String	getType() The type of the participant
String	getUrl() The url to this participant's details page
int	hashCode() This method is implemented for usage in Unit Tests.

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

The identifier of this participant

getDisplayName

public String getDisplayName()

The user readable name of the participant

getDisplayNameKey

public String getDisplayNameKey()

i18n key for the user readable name of the participant, will be used before displayName if present

getType

public String getType()

The type of the participant

getAvatarUrl

public String getAvatarUrl()

The avatar image url of the participant

getUrl

public String getUrl()

The url to this participant's details page

hashCode

public int hashCode()

This method is implemented for usage in Unit Tests.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

This method is implemented for usage in Unit Tests.

Overrides:

equals in class Object

builder

public static HistoryMetadataParticipant.HistoryMetadataParticipantBuilder builder(String id,
                                                                                   String type)

Parameters:

id - the id of the participant being created

type - the type of the participant being created

Returns:

a builder for a HistoryMetadataParticipant object