loci.legacy.adapter

Interface LegacyAdapter<L,M>

Type Parameters:

L - Legacy class

M - Modern class

All Known Implementing Classes:

AbstractLegacyAdapter, CodedEnumAdapter, IRandomAccessAdapter, StatusListenerAdapter, StatusReporterAdapter

public interface LegacyAdapter<L,M>

This interface represents adapter classes for delegating between equivalent "Legacy" and "Modern" classes. Such delegation is intended to facilitate backwards compatibility: given a subclass that extends or implements a Legacy or Modern class, methods requiring the other can be executed on instances of the subclass by using LegacyAdapter#getLegacy(M) or {@link LegacyAdapter#getModern(L) calls, as appropriate.

Delegation is done via mapping instances of legacy classes to instances of modern classes.

This adapter is intended to be used to facilitate delegation between interfaces, which can not themselves contain implementation.

NB: If a package contains extensions or implementations of a Legacy or Modern class, and methods that operate on the extensions (instead of on the base Legacy or Modern class) it can not be made backwards compatible, even with an adapter, and thus we recommend conversion to a fully Modern-based implementation.

Author:

Mark Hiner

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Resets any mappings in this adapter.
L	getLegacy(M modern) Used to retrieve the legacy instance associated with a given modern instance.
M	getModern(L legacy) Used to retrieve the modern instance associated with a given legacy instance.

Method Detail

getLegacy

L getLegacy(M modern)

Used to retrieve the legacy instance associated with a given modern instance.

This is the method that should typically be invoked to convert from Modern to Legacy instances, as opposed to LegacyAdapter#wrapToLegacy(M) which will naively always wrap.

Parameters:

modern - - An instance of the modern class.

Returns:

The associated legacy instance.

getModern

M getModern(L legacy)

Used to retrieve the modern instance associated with a given legacy instance.

This is the method that should typically be invoked to convert from Legacy to Modern instances, as opposed to LegacyAdapter#wrapToModern(L) which will naively always wrap.

Parameters:

legacy - - An instance of the legacy class.

Returns:

The associated modern instance.

clear

void clear()

Resets any mappings in this adapter.