loci.legacy.adapter

Class AbstractLegacyAdapter<L,M>

java.lang.Object

loci.legacy.adapter.AbstractLegacyAdapter<L,M>

All Implemented Interfaces:

LegacyAdapter<L,M>

Direct Known Subclasses:

CodedEnumAdapter, IRandomAccessAdapter, StatusListenerAdapter, StatusReporterAdapter

public abstract class AbstractLegacyAdapter<L,M>
extends Object
implements LegacyAdapter<L,M>

Abstract superclass of all LegacyAdapter implementations.

Uses a WeakHashMap implementation for maintaining associations between legacy and modern classes. "True" instances of each class map to wrappers of their companion classes.

NB: because wrappers are the values in the map, they must be expected to delegate to their key objects (wrapper values wrap their keys).
WeakHashMaps are used to ensure garbage collection when there are no other references to the Legacy/modern pairings.
However, since the values in each pairing wraps the key, there is always a strong reference to each key. Thus we map each key to a WeakReference of the wrapper.

Author:

Mark Hiner

Constructor Summary

Constructors

Constructor and Description
AbstractLegacyAdapter()

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.
protected abstract L	wrapToLegacy(M modern) Used Wraps the given modern object to a new instance of its legacy equivalent.
protected abstract M	wrapToModern(L legacy) Wraps the given legacy object to a new instance of its modern equivalent.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractLegacyAdapter

public AbstractLegacyAdapter()

Method Detail

getModern

public M getModern(L legacy)

Description copied from interface: LegacyAdapter

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.

Specified by:

getModern in interface LegacyAdapter<L,M>

Parameters:

legacy - - An instance of the legacy class.

Returns:

The associated modern instance.

getLegacy

public L getLegacy(M modern)

Description copied from interface: LegacyAdapter

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.

Specified by:

getLegacy in interface LegacyAdapter<L,M>

Parameters:

modern - - An instance of the modern class.

Returns:

The associated legacy instance.

clear

public void clear()

Description copied from interface: LegacyAdapter

Resets any mappings in this adapter.

Specified by:

clear in interface LegacyAdapter<L,M>

wrapToLegacy

protected abstract L wrapToLegacy(M modern)

Used Wraps the given modern object to a new instance of its legacy equivalent.

This is a "stupid" operation that always wraps to a new instance.

This method must be defined at the concrete implementation level as it requires knowledge of a specific class that extends L but is capable of wrapping M. Doing so reduces code/logic repetition by maintaining a single getLegacy implementation.

Parameters:

modern - - An instance of the modern class.

Returns:

A legacy instance wrapping the provided modern instance.

wrapToModern

protected abstract M wrapToModern(L legacy)

Wraps the given legacy object to a new instance of its modern equivalent.

This is a "stupid" operation that always wraps to a new instance.

This method must be defined at the concrete implementation level as it requires knowledge of a specific class that extends M but is capable of wrapping L. Doing so reduces code/logic repetition by maintaining a single getModern implementation.

Parameters:

legacy - - An instance of the legacy class.

Returns:

A modern instance wrapping the provided legacy instance.