com.atlassian.jira.imports.project.core.BackupOverviewBuilder |
Known Indirect Subclasses |
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.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
BackupOverviewBuilder.ConfigurationContext | Represents the CustomField configuration context as stored in the XML Backup. | ||||||||||
BackupOverviewBuilder.FieldConfigSchemeIssueType | Represents the CustomField field configuration issue type context as stored in the XML Backup. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Set additional data into the backup overview that is gathered from plugins.
| |||||||||||
Allows you to register a comment against a project.
| |||||||||||
Allows you to add a reference to an
ExternalComponent . | |||||||||||
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. | |||||||||||
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. | |||||||||||
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. | |||||||||||
Allows you to register an issue against a project.
| |||||||||||
Allows you to add a reference to a
PluginVersion . | |||||||||||
Allows you to add a reference to an
ExternalProject . | |||||||||||
Allows you to add a reference to an
ExternalVersion . | |||||||||||
Returns a
BackupOverview that is populated by the current
state of the builder. | |||||||||||
Used to handle populating the builder from a SAX parser.
| |||||||||||
Registers the JIRA build number with this object.
| |||||||||||
Registers the JIRA edition with this object.
| |||||||||||
Registers the value of the "UnassignedIssuesAllowed" setting.
|
Set additional data into the backup overview that is gathered from plugins.
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
|
@Internal
classes and interfaces can not expect to be compatible with any version
other than the version they were compiled against (even minor version and milestone releases may break binary
compatibility with respect to @Internal
elements).
Allows you to register a comment against a project. Only comment length is stored and not the comment body. Later it's used to find the longest of system text fields (description, environment, comment) in a project.
comment | which has its id and issue set. |
---|
@Internal
classes and interfaces can not expect to be compatible with any version
other than the version they were compiled against (even minor version and milestone releases may break binary
compatibility with respect to @Internal
elements).
Allows you to add a reference to an ExternalComponent
.
component | the component information to associate with the project. |
---|
@Internal
classes and interfaces can not expect to be compatible with any version
other than the version they were compiled against (even minor version and milestone releases may break binary
compatibility with respect to @Internal
elements).
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.
configuration | is the configuration represented in the backup XML. |
---|
@Internal
classes and interfaces can not expect to be compatible with any version
other than the version they were compiled against (even minor version and milestone releases may break binary
compatibility with respect to @Internal
elements).
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.
externalCustomField | is the custom field information represented in the backup XML. |
---|
@Internal
classes and interfaces can not expect to be compatible with any version
other than the version they were compiled against (even minor version and milestone releases may break binary
compatibility with respect to @Internal
elements).
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.
fieldConfigSchemeIssueType | is the linked issue type information represented in the backup XML. |
---|
@Internal
classes and interfaces can not expect to be compatible with any version
other than the version they were compiled against (even minor version and milestone releases may break binary
compatibility with respect to @Internal
elements).
Allows you to register an issue against a project. The issue id's are made available via the
getIssueIds()
method.
issue | which has its id and project set. We should be able to convert the issue id to a long. |
---|
@Internal
classes and interfaces can not expect to be compatible with any version
other than the version they were compiled against (even minor version and milestone releases may break binary
compatibility with respect to @Internal
elements).
Allows you to add a reference to a PluginVersion
.
pluginVersion | the plugin version to add. |
---|
@Internal
classes and interfaces can not expect to be compatible with any version
other than the version they were compiled against (even minor version and milestone releases may break binary
compatibility with respect to @Internal
elements).
Allows you to add a reference to an ExternalProject
.
project | the project to add. |
---|
@Internal
classes and interfaces can not expect to be compatible with any version
other than the version they were compiled against (even minor version and milestone releases may break binary
compatibility with respect to @Internal
elements).
Allows you to add a reference to an ExternalVersion
.
version | the version information to associate with the project. |
---|
Returns a BackupOverview
that is populated by the current
state of the builder.
BackupProject
's and
JIRA system information that has been registered with the builder.
Used to handle populating the builder from a SAX parser. This method will delegate the actual handling
of the element and attributes to an instance of a 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. |
---|
@Internal
classes and interfaces can not expect to be compatible with any version
other than the version they were compiled against (even minor version and milestone releases may break binary
compatibility with respect to @Internal
elements).
Registers the JIRA build number with this object.
buildNumber | the build number as contained in the JIRA backup. |
---|
@Internal
classes and interfaces can not expect to be compatible with any version
other than the version they were compiled against (even minor version and milestone releases may break binary
compatibility with respect to @Internal
elements).
Registers the JIRA edition with this object.
edition | the edition as contained in the JIRA backup. |
---|
@Internal
classes and interfaces can not expect to be compatible with any version
other than the version they were compiled against (even minor version and milestone releases may break binary
compatibility with respect to @Internal
elements).
Registers the value of the "UnassignedIssuesAllowed" setting.
unassignedIssuesAllowed | The value of the "UnassignedIssuesAllowed" setting. |
---|