Package com.atlassian.jira.imports.project.core

Class BackupProjectImpl

java.lang.Object

com.atlassian.jira.imports.project.core.BackupProjectImpl

All Implemented Interfaces:

BackupProject

public class BackupProjectImpl
extends Object
implements BackupProject

Since:

v3.13

Constructor Summary

Constructors

Constructor	Description
BackupProjectImpl(ExternalProject project, List<ExternalVersion> versions, List<ExternalComponent> components, List<ExternalCustomFieldConfiguration> customFieldConfigurations, List<Long> issueIds, int maxSystemFieldTextLength, Map<String,Collection<Object>> additionalData)

Method Summary

Modifier and Type	Method	Description
boolean	containsIssue(String id)
boolean	equals(Object o)
Collection<Object>	getAdditionalData(String key)	Get additional data stored against this key.
ExternalCustomFieldConfiguration	getCustomFieldConfiguration(String customFieldId)	Deprecated.
Collection<ExternalCustomFieldConfiguration>	getCustomFieldConfigurations(String customFieldId)
Collection<ExternalCustomFieldConfiguration>	getCustomFields()
Collection<Long>	getIssueIds()
ExternalProject	getProject()
Collection<ExternalComponent>	getProjectComponents()
Collection<ExternalVersion>	getProjectVersions()
int	getSystemFieldMaxTextLength()	Get maximum length of text system fields found in this project.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BackupProjectImpl

public BackupProjectImpl(ExternalProject project,
 List<ExternalVersion> versions,
 List<ExternalComponent> components,
 List<ExternalCustomFieldConfiguration> customFieldConfigurations,
 List<Long> issueIds,
 int maxSystemFieldTextLength,
 Map<String,Collection<Object>> additionalData)

Method Details

getProject

public ExternalProject getProject()

Specified by:

getProject in interface BackupProject

Returns:

the ExternalProject that is represented in the XML backup.

getProjectVersions

public Collection<ExternalVersion> getProjectVersions()

Specified by:

getProjectVersions in interface BackupProject

Returns:

the ExternalVersion's that are associated with the project returned from BackupProject.getProject().

getProjectComponents

public Collection<ExternalComponent> getProjectComponents()

Specified by:

getProjectComponents in interface BackupProject

Returns:

the ExternalComponent's that are associated with the project returned from BackupProject.getProject().

getIssueIds

public Collection<Long> getIssueIds()

Specified by:

getIssueIds in interface BackupProject

Returns:

the issue id's that are associated with the project returned from BackupProject.getProject().

getCustomFields

public Collection<ExternalCustomFieldConfiguration> getCustomFields()

Specified by:

getCustomFields in interface BackupProject

Returns:

the ExternalCustomFieldConfiguration's that describe the custom fields and their configurations for this project.

getCustomFieldConfiguration

@Deprecated
public ExternalCustomFieldConfiguration getCustomFieldConfiguration(String customFieldId)

Deprecated.

Specified by:

getCustomFieldConfiguration in interface BackupProject

Parameters:

customFieldId - the id of the custom field configuration to retrieve

Returns:

the ExternalCustomFieldConfiguration for the custom field with the specified id, null if the project does not have the custom field with the id.

getCustomFieldConfigurations

public Collection<ExternalCustomFieldConfiguration> getCustomFieldConfigurations(String customFieldId)

Specified by:

getCustomFieldConfigurations in interface BackupProject

Parameters:

customFieldId - the id of the custom field configuration to retrieve

Returns:

the Collection of applicable ExternalCustomFieldConfiguration for the custom field with the specified id, empty collection if the project does not have the custom field with the id.

containsIssue

public boolean containsIssue(String id)

Specified by:

containsIssue in interface BackupProject

Parameters:

id - an issue id that can be converted to a Long

Returns:

true if the backup project contains the issue, false otherwise.

getAdditionalData

public Collection<Object> getAdditionalData(String key)

Description copied from interface: BackupProject

Get additional data stored against this key.

Plugins should namespace keys appropriately to ensure they can store data uniquely.

Plugins would typically store information about what configuration items are used and may be required by items that will be related.

For example: A Plugin that provides Test Planning, might store any Test Plans that are referenced by the issues being imported.

Specified by:

getAdditionalData in interface BackupProject

Parameters:

key - Key under which this data is stored.

Returns:

Collection of data stored under this key.

getSystemFieldMaxTextLength

public int getSystemFieldMaxTextLength()

Description copied from interface: BackupProject

Get maximum length of text system fields found in this project. Used to check if imported project does not exceed jira character limit setting.

Specified by:

getSystemFieldMaxTextLength in interface BackupProject

Returns:

maximum length of issue description, environment, comment or text custom field or 0 if project is empty

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object