net.mdatools.modelant.core.wrap

Class BaseWrapperFactory

java.lang.Object

net.mdatools.modelant.core.wrap.BaseWrapperFactory

All Implemented Interfaces:

WrapperFactory

public abstract class BaseWrapperFactory
extends Object
implements WrapperFactory

This class is the root class for all factories of wrapper classes. CONVENTION:

• each Factory subclass must have all its constructors protected, where one of them must be without parameters. This prevents accidental instantiation of the factory itself this way violating its Singleton property.
• each Factory instance caches internally all the wrapper objects it creates, in order to guarantee:

        (for each X, Y)( factory.wrap(X) == factory.wrap(X) <=> X == Y)
        

• The subclasses must provide the mapping from wrapped to wrapper classes.

Author:

Rusi Popov (popovr@mdatools.net)

Constructor Summary

Constructors

Constructor and Description
BaseWrapperFactory()

Method Summary

Modifier and Type	Method and Description
<A> void	bind(Wrapper<A> wrapper) This method binds an already built wrapper for a wrapped object that has not been used in this factory.
void	destroy() Make sure this method is the last method called on a factory instance.
protected abstract Class<? extends Wrapper>	getMappedClass(Class<?> original) This method maps a class to wrap to the corresponding wrapper class
<A> Wrapper<A>	wrap(A toWrap)
<A> List<Wrapper<A>>	wrap(Collection<A> toWrap)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.mdatools.modelant.core.api.wrap.WrapperFactory

getProperty

Constructor Detail

BaseWrapperFactory

public BaseWrapperFactory()

Method Detail

wrap

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

Specified by:

wrap in interface WrapperFactory

Parameters:

toWrap - could be null

Returns:

a non-null instance unique for each non-null wrapped object or null, when wrapped is null

Throws:

IllegalArgumentException - when there is no wrapper class corresponding to the class of toWrap

wrap

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

Specified by:

wrap in interface WrapperFactory

Parameters:

toWrap - is a non-null collection of (any) objects to wrap

Returns:

a non-null ArrayList of wrapped objects. Note that the type is important, because it is used in any further wrapping

Throws:

IllegalArgumentException - when there is no wrapper class for an object to wrap

See Also:

wrap(Object)

destroy

public final void destroy()

Make sure this method is the last method called on a factory instance.

Specified by:

destroy in interface WrapperFactory

bind

public final <A> void bind(Wrapper<A> wrapper)
                    throws IllegalArgumentException

This method binds an already built wrapper for a wrapped object that has not been used in this factory. Thus, any further call to wrap( wrapper.getWrapped() ) would return the wrapper object.

Specified by:

bind in interface WrapperFactory

Parameters:

wrapper - is a non-null wrapper object

Throws:

IllegalArgumentException - when there is already a wrapper registered for wrapper.getWrapped()

getMappedClass

protected abstract Class<? extends Wrapper> getMappedClass(Class<?> original)

This method maps a class to wrap to the corresponding wrapper class

Parameters:

original - is a non-null class to wrap

Returns:

a possibly null wrapper class for that original class. Null is returned when there is no class to map to.