com.atlassian.jira.imports.project.handler
Interface ImportEntityHandler

All Known Implementing Classes:

AbstractImportPartitionHandler, AttachmentFileValidatorHandler, AttachmentPersisterHandler, BackupOverviewHandler, ChangeGroupPersisterHandler, ChangeItemPersisterHandler, CommentPersisterHandler, ComponentPersisterHandler, CustomFieldMapperHandler, CustomFieldOptionsMapperHandler, CustomFieldValuePersisterHandler, CustomFieldValueValidatorHandler, GroupMapperHandler, IssueComponentMapperHandler, IssueLinkMapperHandler, IssueLinkPersisterHandler, IssueMapperHandler, IssuePartitonHandler, IssuePersisterHandler, IssueRelatedEntitiesPartionHandler, IssueTypeMapperHandler, IssueVersionMapperHandler, LabelsPersisterHandler, ProjectIssueSecurityLevelMapperHandler, ProjectMapperHandler, ProjectRoleActorMapperHandler, RegisterUserMapperHandler, RequiredProjectRolesMapperHandler, SimpleEntityMapperHandler, UserAssociationPersisterHandler, UserMapperHandler, VersionPersisterHandler, WorklogPersisterHandler

public interface ImportEntityHandler

Defines a handler class that will be able to perform some operation given an entity name and the entities attributes. This is meant to be used by registering an instance of this with ChainedSaxHandler.registerHandler(ImportEntityHandler).

Since:

v3.13

Method Summary

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

Method Detail

handleEntity

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

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.

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.

AbortImportException - to indicate to the ChainedSaxHandler that it should abort its SAX parsing.

startDocument

void startDocument()

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

endDocument

void endDocument()

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