com.atlassian.jira.issue.export

Class FieldExportPartsBuilder

java.lang.Object

com.atlassian.jira.issue.export.FieldExportPartsBuilder

@ParametersAreNonnullByDefault
public class FieldExportPartsBuilder
extends Object

Used to build the FieldExportParts.

Since:

7.2.0

Constructor Summary

Constructors

Constructor and Description
FieldExportPartsBuilder()

Method Summary

Modifier and Type	Method and Description
FieldExportPartsBuilder	addItem(String id, String label, java.util.stream.Stream<String> values) Used to add a FieldExportPart with multiple item.
FieldExportPartsBuilder	addItem(String id, String label, String value) Used to add a FieldExportPart with a single item.
FieldExportParts	build() This should be called if you have been using the addItem(java.lang.String, java.lang.String, java.util.stream.Stream<java.lang.String>) to generate each item.
static FieldExportParts	buildSinglePartRepresentation(String id, String label, java.util.stream.Stream<String> values) This generates a representation for the field with a single FieldExportPart but contains multiple values for this.
static FieldExportParts	buildSinglePartRepresentation(String id, String label, String value) This generates a single FieldExportPart with a single value.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldExportPartsBuilder

public FieldExportPartsBuilder()

Method Detail

addItem

public FieldExportPartsBuilder addItem(String id,
                                       String label,
                                       java.util.stream.Stream<String> values)

Used to add a FieldExportPart with multiple item. This can be used if there is a Field component that can have multiple values.

Parameters:

id - of the item, used for sorting and grouping the items over multiple issues

label - to display for the column in this item

values - for the field

Returns:

itself

addItem

public FieldExportPartsBuilder addItem(String id,
                                       String label,
                                       String value)

Used to add a FieldExportPart with a single item. E.g. Project Key from the ProjectSystemField.

Parameters:

id - of the item, used for sorting and grouping the items over multiple issues

label - to display for the column in this item

value - for the field

Returns:

itself

build

public FieldExportParts build()

This should be called if you have been using the addItem(java.lang.String, java.lang.String, java.util.stream.Stream<java.lang.String>) to generate each item.

Returns:

the representation of the field.

buildSinglePartRepresentation

public static FieldExportParts buildSinglePartRepresentation(String id,
                                                             String label,
                                                             @Nullable
                                                             String value)

This generates a single FieldExportPart with a single value. For example, a single text field would use this as there is only one value possible.

Parameters:

id - that represents this item, used for sorting and grouping the items over multiple issues

label - that would be used for the header of the column.

value - for this issue's field, if null it will be replaced by an empty string

Returns:

a representation for the field.

buildSinglePartRepresentation

public static FieldExportParts buildSinglePartRepresentation(String id,
                                                             String label,
                                                             java.util.stream.Stream<String> values)

This generates a representation for the field with a single FieldExportPart but contains multiple values for this. An example of the use of this is CommentSystemField there is only one item but can have many comments.

Parameters:

id - that represents this item, used for sorting and grouping the items over multiple issues

label - for each of the columns of the single item

values - for each of the columns of the item

Returns:

representation of this field