com.atlassian.jira.imports.project.handler
Class CustomFieldValueValidatorHandler

java.lang.Object
  com.atlassian.jira.imports.project.handler.CustomFieldValueValidatorHandler

All Implemented Interfaces:

ImportEntityHandler

public class CustomFieldValueValidatorHandler
extends Object
implements ImportEntityHandler

This handler is used to give the mapped custom fields an opportunity to validate the custom field values that we are going to ask them to map. The custom fields will be provided with the values context NOTE: The mapper that is passed to this class MUST be a mapper that has either categorized EVERY custom field referenced by the custom field values as mapped or ignored. The class will throw ParseException if it encounters a custom field that is not mapped in one of these two states.

Since:

v3.13

Constructor Summary

CustomFieldValueValidatorHandler(BackupProject backupProject, ProjectImportMapper projectImportMapper, CustomFieldManager customFieldManager, Map<String,CustomFieldValueParser> parsers)

Method Summary

void	endDocument() Provides the implementation an opportunity to perform some action when the document is finished being read.
boolean	equals(Object o)
Map	getValidationResults()
void	handleEntity(String entityName, Map<String,String> attributes) This is the main method to implement when using this ImportEntityHandler.
int	hashCode()
void	startDocument() Provides the implementation an opportunity to perform some action when the document is starting to be read.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFieldValueValidatorHandler

public CustomFieldValueValidatorHandler(BackupProject backupProject,
                                        ProjectImportMapper projectImportMapper,
                                        CustomFieldManager customFieldManager,
                                        Map<String,CustomFieldValueParser> parsers)

Method Detail

handleEntity

public void handleEntity(String entityName,
                         Map<String,String> attributes)
                  throws ParseException

Description copied from interface: ImportEntityHandler

This is the main method to implement when using this ImportEntityHandler. This method will provide the entity name and a complete map of attribute key/value pairs. This includes any nested element tags that will have CDATA bodies.

Specified by:

handleEntity in interface ImportEntityHandler

Parameters:

entityName - identifies the entity (i.e. Issue)

attributes - complete list of the attributes listed in the XML element including the nested elements.

Throws:

ParseException - if the entity is invalid a ParseException will be thrown.

getValidationResults

public Map getValidationResults()

startDocument

public void startDocument()

Description copied from interface: ImportEntityHandler

Provides the implementation an opportunity to perform some action when the document is starting to be read.

Specified by:

startDocument in interface ImportEntityHandler

endDocument

public void endDocument()

Description copied from interface: ImportEntityHandler

Provides the implementation an opportunity to perform some action when the document is finished being read.

Specified by:

endDocument in interface ImportEntityHandler

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object