|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BackupOverviewBuilder
This is the intermediate object that collects information from the SAX parser and is able to produce a
BackupOverview
.
This object is used to build up data gleaned from an XML backup. This contains the JIRA information (build number,
edition, plugins, etc.) and all the project information (components, versions, etc.) about the data stored in an
XML backup.
NOTE: This object only collates all its project data when the getBackupOverview()
method is called. This
object is not meant to be used as a transfer object, instead it is an incrementally populated builder.
Method Summary | |
---|---|
void |
addComponent(ExternalComponent component)
Allows you to add a reference to an ExternalComponent . |
void |
addConfigurationContext(BackupOverviewBuilderImpl.ConfigurationContext configuration)
Regiserters a portion of a projects custom field configuration so that the builder can collate this with the addFieldConfigSchemeIssueType(com.atlassian.jira.imports.project.core.BackupOverviewBuilderImpl.FieldConfigSchemeIssueType)
and addExternalCustomField(com.atlassian.jira.external.beans.ExternalCustomField) data to produce a
project relevant custom field configuration. |
void |
addExternalCustomField(ExternalCustomField externalCustomField)
Registers the custom field information portion of a projects custom field configuration so that the builder can collate this with the addConfigurationContext(com.atlassian.jira.imports.project.core.BackupOverviewBuilderImpl.ConfigurationContext)
and addFieldConfigSchemeIssueType(com.atlassian.jira.imports.project.core.BackupOverviewBuilderImpl.FieldConfigSchemeIssueType) data to produce a
project relevant custom field configuration. |
void |
addFieldConfigSchemeIssueType(BackupOverviewBuilderImpl.FieldConfigSchemeIssueType fieldConfigSchemeIssueType)
Regiserters a portion of a projects custom field configuration so that the builder can collate this with the addConfigurationContext(com.atlassian.jira.imports.project.core.BackupOverviewBuilderImpl.ConfigurationContext)
and addExternalCustomField(com.atlassian.jira.external.beans.ExternalCustomField) data to produce a
project relevant custom field configuration. |
void |
addIssue(ExternalIssue issue)
Allows you to register an issue against a project. |
void |
addPluginVersion(PluginVersion pluginVersion)
Allows you to add a reference to a PluginVersion . |
void |
addProject(ExternalProject project)
Allows you to add a reference to an ExternalProject . |
void |
addVersion(ExternalVersion version)
Allows you to add a reference to an ExternalVersion . |
BackupOverview |
getBackupOverview()
Returns a BackupOverview that is populated by the current
state of the builder. |
void |
populateInformationFromElement(String elementName,
Map attributes)
Used to handle populating the builder from a SAX parser. |
void |
setBuildNumber(String buildNumber)
Registers the JIRA build number with this object. |
void |
setEdition(String edition)
Registers the JIRA edition with this object. |
void |
setUnassignedIssuesAllowed(boolean unassignedIssuesAllowed)
Registers the value of the "UnassignedIssuesAllowed" setting. |
Method Detail |
---|
BackupOverview getBackupOverview()
BackupOverview
that is populated by the current
state of the builder.
BackupProject
's and
JIRA system information that has been registered with the builder.void addProject(ExternalProject project)
ExternalProject
.
project
- the project to add.void addPluginVersion(PluginVersion pluginVersion)
PluginVersion
.
pluginVersion
- the plugin version to add.void addVersion(ExternalVersion version)
ExternalVersion
.
version
- the version information to associate with the project.void addComponent(ExternalComponent component)
ExternalComponent
.
component
- the component information to associate with the project.void addIssue(ExternalIssue issue)
BackupProject.getIssueIds()
method.
issue
- which has its id and project set. We should be able to convert the issue id to a long.void setBuildNumber(String buildNumber)
buildNumber
- the build number as contained in the JIRA backup.void setEdition(String edition)
edition
- the edition as contained in the JIRA backup.void setUnassignedIssuesAllowed(boolean unassignedIssuesAllowed)
unassignedIssuesAllowed
- The value of the "UnassignedIssuesAllowed" setting.void addConfigurationContext(BackupOverviewBuilderImpl.ConfigurationContext configuration)
addFieldConfigSchemeIssueType(com.atlassian.jira.imports.project.core.BackupOverviewBuilderImpl.FieldConfigSchemeIssueType)
and addExternalCustomField(com.atlassian.jira.external.beans.ExternalCustomField)
data to produce a
project relevant custom field configuration.
configuration
- is the configuration represented in the backup XML.void addFieldConfigSchemeIssueType(BackupOverviewBuilderImpl.FieldConfigSchemeIssueType fieldConfigSchemeIssueType)
addConfigurationContext(com.atlassian.jira.imports.project.core.BackupOverviewBuilderImpl.ConfigurationContext)
and addExternalCustomField(com.atlassian.jira.external.beans.ExternalCustomField)
data to produce a
project relevant custom field configuration.
fieldConfigSchemeIssueType
- is the linked issue type information represented in the backup XML.void addExternalCustomField(ExternalCustomField externalCustomField)
addConfigurationContext(com.atlassian.jira.imports.project.core.BackupOverviewBuilderImpl.ConfigurationContext)
and addFieldConfigSchemeIssueType(com.atlassian.jira.imports.project.core.BackupOverviewBuilderImpl.FieldConfigSchemeIssueType)
data to produce a
project relevant custom field configuration.
externalCustomField
- is the custom field information represented in the backup XML.void populateInformationFromElement(String elementName, Map attributes) throws ParseException
BackupOverviewPopulator
.
This will then populate this object with the information it gains from the XML information.
elementName
- identifies the XML element.attributes
- identifies the attributes associated with the XML element.
ParseException
- if the attributes are invalid for this element.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |