com.atlassian.jira.issue.export

Class FieldExportPart

java.lang.Object

com.atlassian.jira.issue.export.FieldExportPart

@ExperimentalApi
public class FieldExportPart
extends Object

This represents a single entity for the FieldExportParts.

For example, in the ProjectSystemField the project ID would be one of these FieldExportPart This will store the the id to uniquely identify this item in the FieldExportParts, a label to represent the title of the field item, such as "Project ID". It also stores the values for this field item, this could be like some fields, such as Comments, which store multiple values.

Since:

7.2.0

Method Summary

Modifier and Type	Method and Description
String	getId() Represents a unique Id for this item within the FieldExportParts to allow for grouping.
String	getItemLabel() Gets a label that can be used to uniquely label this item and it's value.
java.util.stream.Stream<String>	getValues() Get the values for this representation item, some field items can have multiple values, such as Comments so this stores all of the different values for this item.

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

Represents a unique Id for this item within the FieldExportParts to allow for grouping. For example, the ProjectSystemField has a Project Key item which would have the id "key" therefore, if there are multiple values for this item it can calculate the maximum values for all the item in the export. This does not need to be unique between different fields, only this field.

Returns:

a unique (in the context of this field) id representing this item

getItemLabel

public String getItemLabel()

Gets a label that can be used to uniquely label this item and it's value. For example, in a CSV export with multiple comments the item label could be "Comment". The implementor of this field can internationalise this value using the I18nHelper in the context if they wish.

Returns:

String label for this item.

getValues

public java.util.stream.Stream<String> getValues()

Get the values for this representation item, some field items can have multiple values, such as Comments so this stores all of the different values for this item.

Returns:

list of values for this item