com.atlassian.jira.issue.changehistory.metadata
Class HistoryMetadata

java.lang.Object
  com.atlassian.jira.issue.changehistory.metadata.HistoryMetadata

@ExperimentalApi
public final class HistoryMetadata
extends Object

Represents the complete set of metadata for a history changegroup.

Since:

JIRA 6.3

Nested Class Summary

static class

HistoryMetadata.HistoryMetadataBuilder

Method Summary

static HistoryMetadata.HistoryMetadataBuilder	builder(String type)
boolean	equals(Object obj) This method is implemented for usage in Unit Tests.
String	getActivityDescription() Textual description of the change for the activity stream
String	getActivityDescriptionKey() i18n key for the description of the change for the activity stream, will be used before activityDescription if present
HistoryMetadataParticipant	getActor() The person or agent that triggered the history change
HistoryMetadataParticipant	getCause() The event or state that triggered the history change
String	getDescription() Textual description of the change
String	getDescriptionKey() i18n key for the textual description of the change, will be used before description if present
String	getEmailDescription() Textual description of the change for notification emails
String	getEmailDescriptionKey() i18n key for the textual description of the change for the notification email, will be used before emailDescription if present
Map<String,String>	getExtraData() Additional metadata related to the history change
HistoryMetadataParticipant	getGenerator() The system that triggered the history change
String	getType() A unique id to identify the plugin/system that generated this metadata
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

getActor

public HistoryMetadataParticipant getActor()

The person or agent that triggered the history change

getGenerator

public HistoryMetadataParticipant getGenerator()

The system that triggered the history change

getCause

public HistoryMetadataParticipant getCause()

The event or state that triggered the history change

getType

public String getType()

A unique id to identify the plugin/system that generated this metadata

getDescription

public String getDescription()

Textual description of the change

getDescriptionKey

public String getDescriptionKey()

i18n key for the textual description of the change, will be used before description if present

getActivityDescription

public String getActivityDescription()

Textual description of the change for the activity stream

getActivityDescriptionKey

public String getActivityDescriptionKey()

i18n key for the description of the change for the activity stream, will be used before activityDescription if present

getEmailDescription

public String getEmailDescription()

Textual description of the change for notification emails

getEmailDescriptionKey

public String getEmailDescriptionKey()

i18n key for the textual description of the change for the notification email, will be used before emailDescription if present

getExtraData

public Map<String,String> getExtraData()

Additional metadata related to the history change

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 HistoryMetadata.HistoryMetadataBuilder builder(String type)

Parameters:

type - the type of the metadata object being created

Returns:

a builder for a HistoryMetadata object