Summary: Methods | [Expand All]
@PublicApi public interface

ProjectImportIdMapper

com.atlassian.jira.imports.project.mapper.ProjectImportIdMapper
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Base interface for a Project Import Id Mapper. Defines a value mapper used for project import. This allows us to map an old value with a new value in the target system. Each instance of this interface represents a particular type of object in the system; eg IssueType, Issue, etc.

Summary

Public Methods
void clearMappedValues()
This will clear any mapped data that may have been entered into the mappers.
Collection<String> getAllMappedIds()
Returns a Collection of all the new IDs that are mapped to.
String getDisplayName(String oldId)
Returns a display name for the given old ID.
String getKey(String oldId)
Returns the registered "key" for the given old ID, or null if none is registered.
String getMappedId(String oldId)
Retrieves a String that corresponds to the id in the target JIRA system, null if none has been mapped.
Collection<String> getRegisteredOldIds()
Returns a collection of ID's as String objects identifying all objects of the appropriate type found in the import file.
Collection<String> getRequiredOldIds()
Returns a collection of ID's as String objects identifying objects from the import file that are required for the import.
@Deprecated Collection<IdKeyPair> getValuesFromImport()
This method is deprecated. Use getRegisteredOldIds()
void mapValue(String oldId, String newId)
This method maps a value from the backup system to a valid value in the target system.

Public Methods

public void clearMappedValues ()

This will clear any mapped data that may have been entered into the mappers. All registered values and values that have been flagged as required will not be changed. This method only affects the mapped data. It is used to re-map and re-validate the data after the user has made changes to the current configuration.

public Collection<String> getAllMappedIds ()

Returns a Collection of all the new IDs that are mapped to.

Returns
  • a Collection of all the new IDs that are mapped to.

public String getDisplayName (String oldId)

Returns a display name for the given old ID. This will normally be the registered key for that ID, but if no key was registered we return the ID in square brackets (eg "[1234]").

Parameters
oldId The old ID.
Returns
  • a display name for the given old ID.
See Also

public String getKey (String oldId)

Returns the registered "key" for the given old ID, or null if none is registered. This is the unique "name" that will be used for automatic mapping of objects in the import file to the objects in the current JIRA system.

Parameters
oldId The old ID.
Returns
  • the registered "key" for the given old ID, or null if none is registered.
See Also

public String getMappedId (String oldId)

Retrieves a String that corresponds to the id in the target JIRA system, null if none has been mapped.

Parameters
oldId identifies the mapping we are looking for.
Returns
  • String that corresponds to the id in the target JIRA system, null if none has been mapped.

public Collection<String> getRegisteredOldIds ()

Returns a collection of ID's as String objects identifying all objects of the appropriate type found in the import file. Note that that this should normally be a super set of the "required" ID's. Each of these ID's will have a unique key associated with it that can be used for mapping old ID's in the import file to "new" ID's in the current JIRA system. You can use the getKey(String) method to extract this key.

Returns
  • a collection of ID's as String objects identifying all objects of the appropriate type found in the import file.
See Also

public Collection<String> getRequiredOldIds ()

Returns a collection of ID's as String objects identifying objects from the import file that are required for the import.

Returns
  • a collection of ID's as String objects identifying objects from the import file that are required for the import.

@Deprecated public Collection<IdKeyPair> getValuesFromImport ()

This method is deprecated.
Use getRegisteredOldIds()

Returns a collection of IdKeyPair representing objects from the import file.

Returns
  • a collection of IdKeyPair representing objects from the import file.
See Also

public void mapValue (String oldId, String newId)

This method maps a value from the backup system to a valid value in the target system.

Parameters
oldId the string representation of the id of the backup value.
newId the string representation of the id of the valid mapped value in the target system.