public interface

CustomFieldParser

com.atlassian.jira.imports.project.parser.CustomFieldParser
Known Indirect Subclasses

Class Overview

Converts custom field and custom field configuration xml in a JIRA backup to an object representation.

Summary

Constants
String CUSTOM_FIELD_CONFIGURATION_ENTITY_NAME
String CUSTOM_FIELD_ENTITY_NAME
String CUSTOM_FIELD_SCHEME_ISSUE_TYPE_ENTITY_NAME
Public Methods
ExternalCustomField parseCustomField(Map attributes)
Parses the custom field data from the backup XML.
BackupOverviewBuilderImpl.ConfigurationContext parseCustomFieldConfiguration(Map attributes)
Parses the custom field configuration context data from the backup XML.
BackupOverviewBuilderImpl.FieldConfigSchemeIssueType parseFieldConfigSchemeIssueType(Map attributes)
Parses the custom field issue type configuration context data from the backup XML.

Constants

public static final String CUSTOM_FIELD_CONFIGURATION_ENTITY_NAME

Constant Value: "ConfigurationContext"

public static final String CUSTOM_FIELD_ENTITY_NAME

Constant Value: "CustomField"

public static final String CUSTOM_FIELD_SCHEME_ISSUE_TYPE_ENTITY_NAME

Constant Value: "FieldConfigSchemeIssueType"

Public Methods

public ExternalCustomField parseCustomField (Map attributes)

Parses the custom field data from the backup XML. This handles the custom field name, description, id, etc.

Parameters
attributes is a map of key value pairs that represent the attributes of an ExternalCustomField. The following attributes are required, otherwise a ParseException will be thrown:
  • id (required)
  • name (required)
  • customfieldtypekey (required)
Returns
  • an ExternalCustomField if the attributes contain the required fields
Throws
ParseException if the required fields are not found in the attributes map

public BackupOverviewBuilderImpl.ConfigurationContext parseCustomFieldConfiguration (Map attributes)

Parses the custom field configuration context data from the backup XML. This provides the project constraints for a custom field and correctly identifies the BackupOverviewBuilderImpl.FieldConfigSchemeIssueType constraints.

Parameters
attributes is a map of key value pairs that represent the attributes of an ConfigurationContext. The following attributes are required, otherwise a ParseException will be thrown:
  • id (required)
  • key (required)
Also, if the key does not start with "customfield_" then we will return a null ConfigurationContext meaning this parser can not handle the value.
Returns
  • a ConfigurationContext that identifies a single context for a custom field, null if the ConfigurationContext is not a custom field configuration context.
Throws
ParseException if the attributes map does not contain the required fields or the field data is invalid

public BackupOverviewBuilderImpl.FieldConfigSchemeIssueType parseFieldConfigSchemeIssueType (Map attributes)

Parses the custom field issue type configuration context data from the backup XML. This provides the issue type constrains for a BackupOverviewBuilderImpl.ConfigurationContext, if any exist.

Parameters
attributes is a map of key value pairs that represent the attributes of an FieldConfigSchemeIssueType. The following attributes are required, otherwise a ParseException will be thrown:
  • id (required)
  • fieldconfigscheme (required)
  • issuetype (required)
Returns
  • a FieldConfigSchemeIssueType that identifies the issue types a custom field context is constrained by
Throws
ParseException if the attributes do not contain a required field