net.mdatools.modelant.core.wrap

Class BaseWrapper<A>

java.lang.Object

net.mdatools.modelant.core.wrap.BaseWrapper<A>

All Implemented Interfaces:

Serializable, Wrapper<A>

public abstract class BaseWrapper<A>
extends Object
implements Serializable, Wrapper<A>

This class is the root class for all wrapper classes.
INVARIANT:

• the wrapped object is never null
• the factory object is never null
• the factory is exactly one that created this object

Additional methods (not related actually to the wrapping function of this class) are added to ease the use of this class for code generation.

Author:

Rusi Popov (popovr@mdatools.net)

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseWrapper(A wrapped, WrapperFactory factory)

Method Summary

Modifier and Type	Method and Description
protected WrapperFactory	getFactory() The factory for this instance
A	getWrapped() CONVENTION: when the wrapper is used to create a new wrapped object, it might happen that this method needs public access.
Wrapper<A>	wrap(A toWrap) Call this method in subclasses in order to instantiate the wrapper class that actually corresponds to the class of the object toWrap
List<Wrapper<A>>	wrap(Collection<A> toWrap) Call this method in subclasses in order to instantiate the wrapper class that actually corresponds to the class of the object toWrap

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseWrapper

protected BaseWrapper(A wrapped,
                      WrapperFactory factory)

Parameters:

wrapped - is non-null object to wrap

factory - is the non-null factory that created this

Method Detail

getWrapped

public final A getWrapped()

CONVENTION:

• when the wrapper is used to create a new wrapped object, it might happen that this method needs public access.
• when wrapping a wrapper, this method is overridden, this way granting the outer-most wrapper access to the nested-most wrapped object (bypassing the wrappers)

Specified by:

getWrapped in interface Wrapper<A>

Returns:

the deepest wrapped object

getFactory

protected final WrapperFactory getFactory()

The factory for this instance

Returns:

the wrapper factory this was constructed with

wrap

public final Wrapper<A> wrap(A toWrap)
                      throws IllegalArgumentException

Call this method in subclasses in order to instantiate the wrapper class that actually corresponds to the class of the object toWrap

Specified by:

wrap in interface Wrapper<A>

Parameters:

toWrap - is the object to wrap in another wrapper class. Might be null;

Returns:

null, when null provided, otherwise a properly initialized wrapper class that wraps toWrap

Throws:

IllegalArgumentException - when mapping is not possible

See Also:

Wrapper.wrap(Object)

wrap

public final List<Wrapper<A>> wrap(Collection<A> toWrap)
                            throws IllegalArgumentException

Call this method in subclasses in order to instantiate the wrapper class that actually corresponds to the class of the object toWrap

Specified by:

wrap in interface Wrapper<A>

Parameters:

toWrap - is the object to wrap in another wrapper class. Might be null;

Returns:

null, when null provided, otherwise a properly initialized collection of wrappers that wrap the elements of toWrap

Throws:

IllegalArgumentException - when mapping is not possible

See Also:

Wrapper.wrap(Collection)