loci.common.adapter

Class CodedEnumAdapter

java.lang.Object

loci.legacy.adapter.AbstractLegacyAdapter<CodedEnum,CodedEnum>

loci.common.adapter.CodedEnumAdapter

All Implemented Interfaces:

LegacyAdapter<CodedEnum,CodedEnum>

public class CodedEnumAdapter
extends AbstractLegacyAdapter<CodedEnum,CodedEnum>

As interfaces can not contain implementation, this class manages interface-level delegation between CodedEnum and CodedEnum

Delegation is maintained by two WeakHashTables. See AbstractLegacyAdapter

Functionally, the delegation is handled in the nested classes - one for wrapping from ome.scifio.common.enumeration.CodedEnum to loci.common.enumeration.CodedEnum, and one for the reverse direction.

Author:

Mark Hiner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodedEnumAdapter.LegacyWrapper This class can be used to wrap loci.common.enumeration.CodedEnum objects and be passed to API expecting an ome.scifio.enumeration.CodedEnum object.
static class	CodedEnumAdapter.ModernWrapper This class can be used to wrap ome.scifio.enumeration.CodedEnum objects and be passed to API expecting a loci.common.enumeration.CodedEnum object.

Constructor Summary

Constructors

Constructor and Description
CodedEnumAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
protected CodedEnum	wrapToLegacy(CodedEnum modern) Used Wraps the given modern object to a new instance of its legacy equivalent.
protected CodedEnum	wrapToModern(CodedEnum legacy) Wraps the given legacy object to a new instance of its modern equivalent.

Methods inherited from class loci.legacy.adapter.AbstractLegacyAdapter

clear, getLegacy, getModern

Methods inherited from class java.lang.Object

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

Constructor Detail

CodedEnumAdapter

public CodedEnumAdapter()

Method Detail

wrapToLegacy

protected CodedEnum wrapToLegacy(CodedEnum modern)

Description copied from class: AbstractLegacyAdapter

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.

Specified by:

wrapToLegacy in class AbstractLegacyAdapter<CodedEnum,CodedEnum>

Parameters:

modern - - An instance of the modern class.

Returns:

A legacy instance wrapping the provided modern instance.

wrapToModern

protected CodedEnum wrapToModern(CodedEnum legacy)

Description copied from class: AbstractLegacyAdapter

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.

Specified by:

wrapToModern in class AbstractLegacyAdapter<CodedEnum,CodedEnum>

Parameters:

legacy - - An instance of the legacy class.

Returns:

A modern instance wrapping the provided legacy instance.