com.atlassian.jira.imports.project.parser

Interface CustomFieldValueParser

All Known Subinterfaces:

ProjectImportableCustomFieldParser, ProjectImportLabelFieldParser

All Known Implementing Classes:

CustomFieldValueParserImpl, LabelsCFType, ProjectImportLabelFieldParserImpl

public interface CustomFieldValueParser

Converts custom field value xml in a JIRA backup to an object representation and converts the object into the EntityRepresentation.

Since:

v3.13

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOM_FIELD_VALUE_ENTITY_NAME

Method Summary

Modifier and Type	Method and Description
EntityRepresentation	getEntityRepresentation(ExternalCustomFieldValue customFieldValue) Gets an EntityRepresentation that contains the correct attributes based on the populated fields in the provided custom field value.
ExternalCustomFieldValue	parse(Map attributes) Parses the custom field value data from the backup XML.

Field Detail

CUSTOM_FIELD_VALUE_ENTITY_NAME

static final String CUSTOM_FIELD_VALUE_ENTITY_NAME

See Also:

Constant Field Values

Method Detail

parse

ExternalCustomFieldValue parse(Map attributes)
                        throws ParseException

Parses the custom field value data from the backup XML.

Parameters:

attributes - is a map of key value pairs that represent the attributes of an ExternalCustomFieldValue. The following attributes are required, otherwise a ParseException will be thrown:

• id (required)
• customfield (required)
• issue (required)

Returns:

an ExternalCustomFieldValue if the attributes contain the required fields

Throws:

ParseException - if the required fields are not found in the attributes map

getEntityRepresentation

EntityRepresentation getEntityRepresentation(ExternalCustomFieldValue customFieldValue)

Gets an EntityRepresentation that contains the correct attributes based on the populated fields in the provided custom field value.

Parameters:

customFieldValue - contains the populated fields that will end up in the EntityRepresentations map

Returns:

an EntityRepresentation that can be persisted using OfBiz