com.botronsoft.cmj.spi.issue

Interface CustomFieldDataHandler<T>

Type Parameters:

T - the type of the value - this should be the same as T (transport object type) that is declared in the CustomFieldType implementation in the app.

@PublicSpi
public interface CustomFieldDataHandler<T>

Interface for migrating custom field values. Values for custom fields can be stored in two places - the current value of the issue and also values in the issue history. For this purpose there are methods in this interface for converting both current values and history values.

Method Summary

Modifier and Type	Method and Description
Optional<String>	transformChangeLogValueForExport(com.atlassian.jira.issue.fields.CustomField customField, com.atlassian.jira.issue.Issue issue, String value, String valueString, IssueExportContext issueExportContext) Transforms an issue history value for the given custom field to a serialized String.
Optional<String>	transformIssueValueForExport(com.atlassian.jira.issue.fields.CustomField customField, com.atlassian.jira.issue.Issue issue, T value, IssueExportContext issueExportContext) Transforms an issue value for the given custom field to a serialized String.
Optional<T>	transformIssueValueForImport(com.atlassian.jira.issue.fields.CustomField customField, com.atlassian.jira.issue.Issue issue, String value, IssueImportContext issueImportContext) Transform a previously serialized value for import.

Method Detail

transformIssueValueForExport

Optional<String> transformIssueValueForExport(com.atlassian.jira.issue.fields.CustomField customField,
                                              com.atlassian.jira.issue.Issue issue,
                                              T value,
                                              IssueExportContext issueExportContext)

Transforms an issue value for the given custom field to a serialized String. This method will be called by Configuration Manager for each issue if it contains a value for this field.

Parameters:

customField - the custom field for which the value is exported. The field is of type for which this handler has been registered.

issue - the issue for which the value is exported.

value - the value itself.

issueExportContext - the context of the export operation.

Returns:

an Optional containing the exported value serialized as a String. This value will be passed to the CustomFieldDataHandlertransformIssueValueForImport(CustomField, Issue, String, IssueImportContext) method on import.

transformChangeLogValueForExport

Optional<String> transformChangeLogValueForExport(com.atlassian.jira.issue.fields.CustomField customField,
                                                  com.atlassian.jira.issue.Issue issue,
                                                  String value,
                                                  String valueString,
                                                  IssueExportContext issueExportContext)

Transforms an issue history value for the given custom field to a serialized String. This method will be called by Configuration Manager for each value in a history entry for this field.

Parameters:

customField - the custom field for which the value is exported. The field is of type for which this handler has been registered.

issue - the issue for which the value is exported.

value - the value from the history entry.

valueString - the value string from the history entry.

issueExportContext - the context of the export operation.

Returns:

an Optional containing the exported value serialized as a String. This value will be passed to CustomFieldType.getChangelogValue(CustomField, Object) and CustomFieldType.getChangelogString(CustomField, Object) when the history entry is imported.

transformIssueValueForImport

Optional<T> transformIssueValueForImport(com.atlassian.jira.issue.fields.CustomField customField,
                                         com.atlassian.jira.issue.Issue issue,
                                         String value,
                                         IssueImportContext issueImportContext)

Transform a previously serialized value for import. The resulting type must be the one declared in the CustomFieldType implementation in the app.

Parameters:

customField - the custom field for which the value is imported. The field is of type for which this handler has been registered.

issue - the issue for which the value is imported.

value - the value itself.

issueImportContext - the context of the import operation.

Returns:

an Optional containing the value for this custom field type.