@ExperimentalApi public final class

HistoryMetadata

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

@ExperimentalApi

This class is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

Represents the complete set of metadata for a history changegroup.

Summary

Nested Classes
class HistoryMetadata.HistoryMetadataBuilder  
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static HistoryMetadata.HistoryMetadataBuilder builder (String type)

Parameters
type the type of the metadata object being created
Returns
  • a builder for a HistoryMetadata object

public boolean equals (Object obj)

This method is implemented for usage in Unit Tests.

public String getActivityDescription ()

Textual description of the change for the activity stream

public String getActivityDescriptionKey ()

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

public HistoryMetadataParticipant getActor ()

The person or agent that triggered the history change

public HistoryMetadataParticipant getCause ()

The event or state that triggered the history change

public String getDescription ()

Textual description of the change

public String getDescriptionKey ()

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

public String getEmailDescription ()

Textual description of the change for notification emails

public String getEmailDescriptionKey ()

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

public Map<String, String> getExtraData ()

Additional metadata related to the history change

public HistoryMetadataParticipant getGenerator ()

The system that triggered the history change

public String getType ()

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

public int hashCode ()

This method is implemented for usage in Unit Tests.