com.toolsverse.util.factory

Class ObjectFactory

Object

com.toolsverse.util.factory.ObjectFactory

public class ObjectFactory
extends Object

An ObjectFactory is responsible for creating objects of a specific type. The framework allows for object implementations to be loaded in dynamically via object factory. For example, when creating a parser, if Parser interface binded to ParticularParser implementation the Parser could be used to create a parser object. If needed objects can be created as "singletons". This is not a real singleton which itself can be instantiated only once, instead the ObjectFactory will return a reference to the same object if called with the same parameters. The mapping between interfaces and implementations is usually stored in the property files but also can be dynamically changed via bind method of the registered ObjectFactoryModule class.

An ObjectFactory can create objects based on the current execution context. For example there is a binding:

com.toolsverse.util.lang.ParserTypeFactory.client=com.toolsverse.ui.swing.codeeditor.RSyntaxTextAreaParserTypeFactory

com.toolsverse.util.lang.ParserTypeFactory.server=com.toolsverse.ui.wings.codeeditor.CodeMirrorParserTypeFactory

if system property app.deployment=client ObjectFactory returns RSyntaxTextAreaParserTypeFactory, if it is app.deployment=server ObjectFactory returns CodeMirrorParserTypeFactory.

Since:

1.0

Version:

2.0

See Also:

ObjectFactoryModule

Field Summary

Fields

Modifier and Type	Field and Description
static String	OBJECT_FACTORY_OBJECTS OBJECT_FACTORY_OBJECTS.

Method Summary

Modifier and Type	Method and Description
Object	get(String name) Creates an object which either implements name interface or is an instance of the name class.
Object	get(String name, boolean singleton) If singleton == true creates a "singleton" instance of the object which either implements name interface or is an instance of the name class.
Object	get(String name, Class<?> classTo) Creates an object which either implements name interface or is an instance of the name class.
Object	get(String name, Class<?> classTo, boolean singleton) If singleton== true creates a "singleton" instance of the object which either implements name interface or is an instance of the name class.
Object	get(String name, String realClassName) First tries to create an object which either implements name interface or is an instance of the name class.
Object	get(String name, String defaultName, boolean singleton) If singleton == true first tries to create a "singleton" instance of the object which either implements name interface or is an instance of the name class.
Object	get(String name, String defaultName, Class<?> classTo, boolean singleton) If singleton == true first tries to create a "singleton" instance of the object which either implements name interface or is an instance of the name class.
Object	get(String name, String defaultName, String realClassName) First tries to create an object which either implements name interface or is an instance of the name class.
Object	get(String name, String defaultName, String realClassName, Class<?> classTo) First tries to create an object which either implements name interface or is an instance of the name class.
Object	get(String name, String defaultName, String realClassName, Class<?> classTo, boolean singleton, boolean checkLicense) First tries to create an object which either implements name interface or is an instance of the name class.
static ObjectFactory	instance() Instance.
void	register(ObjectFactoryModule module) Registers ObjectFactoryModule.
void	unRegister(ObjectFactoryModule module) Unregisters ObjectFactoryModule.

Methods inherited from class Object

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

Field Detail

OBJECT_FACTORY_OBJECTS

public static final String OBJECT_FACTORY_OBJECTS

OBJECT_FACTORY_OBJECTS.

See Also:

Constant Field Values

Method Detail

instance

public static ObjectFactory instance()

Instance.

Returns:

the ObjectFactory

get

public Object get(String name)

Creates an object which either implements name interface or is an instance of the name class. If object can not be created returns null.

Parameters:

name - the name of the class

Returns:

the object

get

public Object get(String name,
                  boolean singleton)

If singleton == true creates a "singleton" instance of the object which either implements name interface or is an instance of the name class. Otherwise just creates an object. If object can not be created returns null.

Parameters:

name - the name of the class

singleton - if true the singleton object will be created

Returns:

the object

get

public Object get(String name,
                  Class<?> classTo)

Creates an object which either implements name interface or is an instance of the name class. If object can not be created or can not be cast to classTo returns null.

Parameters:

name - the name of the class

classTo - the class to cast to

Returns:

the object

get

public Object get(String name,
                  Class<?> classTo,
                  boolean singleton)

If singleton== true creates a "singleton" instance of the object which either implements name interface or is an instance of the name class. Otherwise just creates an object. If object can not be created or can not be cast to classTo returns null.

Parameters:

name - the name of the class

classTo - the class to cast to

singleton - if true the singleton object will be created

Returns:

the object

get

public Object get(String name,
                  String realClassName)

First tries to create an object which either implements name interface or is an instance of the name class. If it fails uses realClassName. If it also fails returns null.

Parameters:

name - the name of the class

realClassName - the alternative name of the class

Returns:

the object

get

public Object get(String name,
                  String defaultName,
                  boolean singleton)

If singleton == true first tries to create a "singleton" instance of the object which either implements name interface or is an instance of the name class. If it fails uses defaultName. If it also fails returns null.

Parameters:

name - the name of the class

defaultName - the alternative name of the class

singleton - if true the singleton object will be created

Returns:

the object

get

public Object get(String name,
                  String defaultName,
                  Class<?> classTo,
                  boolean singleton)

If singleton == true first tries to create a "singleton" instance of the object which either implements name interface or is an instance of the name class. If it fails uses defaultName. If it also fails or object can not be cast to classTo returns null.

Parameters:

name - the name of the class

defaultName - the alternative name of the class

classTo - the class to cast to

singleton - if true the singleton object will be created

Returns:

the object

get

public Object get(String name,
                  String defaultName,
                  String realClassName)

First tries to create an object which either implements name interface or is an instance of the name class. If it fails uses realClassName. If it fails uses defaultName as a last resort. If it also fails returns null.

Parameters:

name - the name of the class

defaultName - the "last resort" name of class if both name and realClassName didn't work

realClassName - the alternative name of the class

Returns:

the object

get

public Object get(String name,
                  String defaultName,
                  String realClassName,
                  Class<?> classTo)

First tries to create an object which either implements name interface or is an instance of the name class. If it fails uses realClassName. If it fails uses defaultName as a last resort. If it also fails or object can not be cast to classTo returns null.

Parameters:

name - the name of the class

defaultName - the "last resort" name of class if both name and realClassName didn't work

realClassName - the alternative name of the class

classTo - the class to cast to

Returns:

the object

get

public Object get(String name,
                  String defaultName,
                  String realClassName,
                  Class<?> classTo,
                  boolean singleton,
                  boolean checkLicense)

First tries to create an object which either implements name interface or is an instance of the name class. If it fails uses realClassName. If it fails uses defaultName as a last resort. If it also fails or object can not be cast to classTo returns null. If singleton == true the object will be created as "singleton".

Parameters:

name - the name of the class

defaultName - the "last resort" name of class if both name and realClassName didn't work

realClassName - the alternative name of the class

classTo - the class to cast to

singleton - if true the singleton object will be created

checkLicense - the check license flag. If true object factory checks license

Returns:

the object

register

public void register(ObjectFactoryModule module)

Registers ObjectFactoryModule.

Parameters:

module - the ObjectFactoryModule

unRegister

public void unRegister(ObjectFactoryModule module)

Unregisters ObjectFactoryModule.

Parameters:

module - the ObjectFactoryModule