SimpleProjectImportIdMapper

implements MapperEntityRegister ProjectImportIdMapper

com.atlassian.jira.imports.project.mapper.SimpleProjectImportIdMapper

Known Indirect Subclasses

GroupMapper, SimpleProjectImportIdMapperImpl

@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

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 ProjectImportIdMapper represents a particular type of object in the system; eg IssueType, Issue, etc.

Summary

Public Methods
void	flagValueAsRequired(String oldId) Flags an old value, which should eventually be registered via `registerOldValue(String, String)`, such that this mapper will indicate that the value MUST be mapped to a new value.

[Expand]

Inherited Methods

From interface com.atlassian.jira.imports.project.mapper.MapperEntityRegister

From interface com.atlassian.jira.imports.project.mapper.ProjectImportIdMapper

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 flagValueAsRequired (String oldId)

Flags an old value, which should eventually be registered via registerOldValue(String, String), such that this mapper will indicate that the value MUST be mapped to a new value.

Parameters

oldId	the string representation for the id of the backup value.

Interfaces