public interface BackupOverviewBuilder
BackupOverview
.
getBackupOverview()
method is called. This
object is not meant to be used as a transfer object, instead it is an incrementally populated builder.Modifier and Type | Interface and Description |
---|---|
static class |
BackupOverviewBuilder.ConfigurationContext
Represents the CustomField configuration context as stored in the XML Backup.
|
static class |
BackupOverviewBuilder.FieldConfigSchemeIssueType
Represents the CustomField field configuration issue type context as stored in the XML Backup.
|
Modifier and Type | Method and Description |
---|---|
void |
addAdditionalData(String key,
String projectId,
Object data)
Set additional data into the backup overview that is gathered from plugins.
|
void |
addComment(ExternalComment comment)
Allows you to register a comment against a project.
|
void |
addComponent(ExternalComponent component)
Allows you to add a reference to an
ExternalComponent . |
void |
addConfigurationContext(BackupOverviewBuilder.ConfigurationContext configuration)
Registers a portion of a projects custom field configuration so that the builder can collate this with the
addFieldConfigSchemeIssueType(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(ConfigurationContext)
and addFieldConfigSchemeIssueType(FieldConfigSchemeIssueType) data to produce a
project relevant custom field configuration. |
void |
addFieldConfigSchemeIssueType(BackupOverviewBuilder.FieldConfigSchemeIssueType fieldConfigSchemeIssueType)
Registers a portion of a projects custom field configuration so that the builder can collate this with the
addConfigurationContext(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.
|
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.@Internal void addProject(ExternalProject project)
ExternalProject
.project
- the project to add.@Internal void addPluginVersion(PluginVersion pluginVersion)
PluginVersion
.pluginVersion
- the plugin version to add.@Internal void addVersion(ExternalVersion version)
ExternalVersion
.version
- the version information to associate with the project.@Internal void addComponent(ExternalComponent component)
ExternalComponent
.component
- the component information to associate with the project.@Internal 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.@Internal void addComment(ExternalComment comment)
comment
- which has its id and issue set.@Internal void setBuildNumber(String buildNumber)
buildNumber
- the build number as contained in the JIRA backup.@Internal void setEdition(String edition)
edition
- the edition as contained in the JIRA backup.@Internal void setUnassignedIssuesAllowed(boolean unassignedIssuesAllowed)
unassignedIssuesAllowed
- The value of the "UnassignedIssuesAllowed" setting.@Internal void addConfigurationContext(BackupOverviewBuilder.ConfigurationContext configuration)
addFieldConfigSchemeIssueType(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.@Internal void addFieldConfigSchemeIssueType(BackupOverviewBuilder.FieldConfigSchemeIssueType fieldConfigSchemeIssueType)
addConfigurationContext(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.@Internal void addExternalCustomField(ExternalCustomField externalCustomField)
addConfigurationContext(ConfigurationContext)
and addFieldConfigSchemeIssueType(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.void addAdditionalData(String key, String projectId, Object data)
key
- A unique key for the plugin.projectId
- The project the data relates to.data
- Data to be stored against the key. The data will be added to a list and eventually stored in the
and accessible via
Copyright © 2002-2019 Atlassian. All Rights Reserved.