com.atlassian.jira.imports.project.parser

Interface ChangeItemParser

All Known Implementing Classes:

ChangeItemParserImpl

public interface ChangeItemParser

Converts change item xml in a JIRA backup to an object representation and converts the object representation into EntityRepresentation.

Since:

v3.13

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHANGE_ITEM_ENTITY_NAME

Method Summary

Modifier and Type	Method and Description
EntityRepresentation	getEntityRepresentation(ExternalChangeItem changeItem) Gets an EntityRepresentation that contains the correct attributes based on the populated fields in the provided ExternalChangeItem.
ExternalChangeItem	parse(Map attributes) Parses the ChangeItem data from the backup XML.

Field Detail

CHANGE_ITEM_ENTITY_NAME

static final String CHANGE_ITEM_ENTITY_NAME

See Also:

Constant Field Values

Method Detail

parse

ExternalChangeItem parse(Map attributes)
                  throws ParseException

Parses the ChangeItem data from the backup XML.

Parameters:

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

• id (required)
• group (required)
• fieldtype (required)
• field (required)

Returns:

an ExternalChangeItem if the attributes contain the required fields

Throws:

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

getEntityRepresentation

EntityRepresentation getEntityRepresentation(ExternalChangeItem changeItem)

Gets an EntityRepresentation that contains the correct attributes based on the populated fields in the provided ExternalChangeItem.

Parameters:

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

Returns:

an EntityRepresentation that can be persisted using OfBiz