com.atlassian.jira.imports.project.handler

Class BackupOverviewHandler

java.lang.Object

com.atlassian.jira.imports.project.handler.BackupOverviewHandler

All Implemented Interfaces:

ImportEntityHandler

public class BackupOverviewHandler
extends Object
implements ImportEntityHandler

Performs the first pass on the XML backup for a ProjectImport. This will populate a BackupOverview object that can be used to prompt the user with which project to import.

Since:

v3.13

Constructor Summary

Constructors

Constructor and Description
BackupOverviewHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	endDocument() Provides the implementation an opportunity to perform some action when the document is finished being read.
BackupOverview	getBackupOverview()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackupOverviewHandler

public BackupOverviewHandler()

Method Detail

getBackupOverview

public BackupOverview getBackupOverview()

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.

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