cz.ues.platform.container

Class UESComponentFactory

java.lang.Object

cz.ues.platform.container.UESComponentFactory

public abstract class UESComponentFactory
extends java.lang.Object

Component Factory is general factory to provide components for application.

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
private static UESComponentFactory	factory Instance of initialized factory.
private static java.lang.String	FACTORY_IMPLEMENTATION Name of factory default implementation class.
static java.lang.String	UNDEFINED_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UESComponentFactory() ComponentFactory will never be instantiated.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	containsComponent(java.lang.Class<?> aCompClass) Checks if component factory contains component of given type.
static boolean	containsComponent(java.lang.Class<?> aCompClass, java.lang.String aCompName) Checks if component factory contains component of given class and name (Default component name of name explicitly defined on component implementation class or interface).
protected abstract boolean	containsComponentInternal(java.lang.Class<?> aCompClass, java.lang.String aCompName) Checks if component factory contains component of given class and name (Default component name of name explicitly defined on component implementation class or interface).
static <T> T	getComponent(java.lang.Class<T> aCompClass) Returns application component based on given type.
static <T> T	getComponent(java.lang.Class<T> aCompClass, java.lang.String aCompName) Returns application component of given class and name (Default component name or name explicitly defined on component implementation class or interface).
protected abstract <T> T	getComponentInternal(java.lang.Class<T> aCompClass, java.lang.String aCompName) Returns application component of given class and name (Default component name or name explicitly defined on component implementation class or interface).
protected static UESComponentFactory	getFactory() Synchronized with UESComponentFactory.initFactory() to avoid problems when not already initialized and some other thread calls the UESComponentFactory.getComponent(Class, String).
protected abstract void	init() Initializes the ComponentFactory before its usage.
private static UESComponentFactory	initFactory() Bootstraps the component factory.
static void	initialize() Initialize component factory.

Methods inherited from class java.lang.Object

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

Field Detail

factory

private static final factory

Instance of initialized factory.

FACTORY_IMPLEMENTATION

private static final FACTORY_IMPLEMENTATION

Name of factory default implementation class.

See Also:

Constant Field Values

UNDEFINED_NAME

public static final UNDEFINED_NAME

See Also:

Constant Field Values

Constructor Detail

UESComponentFactory

protected UESComponentFactory()

ComponentFactory will never be instantiated.

Method Detail

initialize

public static void initialize()

Initialize component factory. Invocation of this method is optional, factory is automatically lazy initialized by calling of any other method.

Since:

UES7-04

initFactory

private static UESComponentFactory initFactory()

Bootstraps the component factory.

Returns:

Instance of initialized factory

Since:

UES6-00

getComponent

public static <T> T getComponent(java.lang.Class<T> aCompClass)
throws UESComponentFactoryRTException

Returns application component based on given type. If multiple components of same type are found (and no component priority is defined) exception is thrown.

Type Parameters:

T - Type of component

Parameters:

aCompClass - Component class

Returns:

Instance of component

Throws:

UESComponentFactoryRTException - In case initialization of component fails

Since:

UES6-00

containsComponent

public static boolean containsComponent(java.lang.Class<?> aCompClass)
throws UESComponentFactoryRTException

Checks if component factory contains component of given type.

Parameters:

aCompClass - Component class

Returns:

True if component exists in some container, else false

Throws:

UESComponentFactoryRTException - In case checking of component existence fails

Since:

UES6-00

getFactory

protected static UESComponentFactory getFactory()

Synchronized with UESComponentFactory.initFactory() to avoid problems when not already initialized and some other thread calls the UESComponentFactory.getComponent(Class, String).

Returns:

the initialized factory.

Since:

UES6-00

getComponent

public static <T> T getComponent(java.lang.Class<T> aCompClass,
java.lang.String aCompName)
throws UESComponentFactoryRTException

Returns application component of given class and name (Default component name or name explicitly defined on component implementation class or interface).

Type Parameters:

T - Type of component

Parameters:

aCompClass - Component class

aCompName - Name of component

Returns:

Instance of component

Throws:

UESComponentFactoryRTException - In case initialization of component fails

Since:

UES6-00

containsComponent

public static boolean containsComponent(java.lang.Class<?> aCompClass,
java.lang.String aCompName)
throws UESComponentFactoryRTException

Checks if component factory contains component of given class and name (Default component name of name explicitly defined on component implementation class or interface).

Parameters:

aCompClass - Component class

aCompName - Name of component

Returns:

True if component exists in some container, else false

Throws:

UESComponentFactoryRTException - In case checking of component existence fails

Since:

UES6-00

getComponentInternal

protected abstract <T> T getComponentInternal(java.lang.Class<T> aCompClass,
java.lang.String aCompName)
throws UESComponentFactoryRTException

Returns application component of given class and name (Default component name or name explicitly defined on component implementation class or interface).

Type Parameters:

T - Type of component

Parameters:

aCompClass - Component class

aCompName - Name of component

Returns:

Instance of component

Throws:

UESComponentFactoryRTException - In case initialization of component fails

UESComponentFactoryRTException

Since:

UES6-00

containsComponentInternal

protected abstract boolean containsComponentInternal(java.lang.Class<?> aCompClass,
java.lang.String aCompName)
throws UESComponentFactoryRTException

Checks if component factory contains component of given class and name (Default component name of name explicitly defined on component implementation class or interface).

Parameters:

aCompClass - Component class

aCompName - Name of component

Returns:

True if component exists in some container, else false

Throws:

UESComponentFactoryRTException - In case checking of component existence fails

Since:

UES6-00

init

protected abstract void init()
throws UESComponentFactoryRTException

Initializes the ComponentFactory before its usage.

Throws:

UESComponentFactoryRTException - In case initialization of factory fails

Since:

UES6-00