org.openbase.bco.dal.remote.unit

Class UnitRemoteFactoryImpl

java.lang.Object

org.openbase.bco.dal.remote.unit.UnitRemoteFactoryImpl

All Implemented Interfaces:

UnitRemoteFactory, org.openbase.jul.pattern.Factory<UnitRemote,rst.domotic.unit.UnitConfigType.UnitConfig>

public class UnitRemoteFactoryImpl
extends Object
implements UnitRemoteFactory

A unit remote factory which can be used to create unit remote instances out of the unit registry delivered unit configurations.

Author:

Divine Threepwood

Method Summary

Modifier and Type	Method and Description
AbstractUnitRemote	createAndInitUnitRemote(rst.domotic.unit.UnitConfigType.UnitConfig config) Deprecated.
AbstractUnitRemote	createUnitRemote(rst.domotic.unit.UnitConfigType.UnitConfig config) Deprecated. use newInstance instead!
static UnitRemoteFactory	getInstance() Method returns a new singelton instance of the unit factory.
static Class<? extends AbstractUnitRemote>	loadUnitRemoteClass(rst.domotic.unit.UnitConfigType.UnitConfig config) Method resolves the unit remote class of the given unit config.
static Class<? extends AbstractUnitRemote>	loadUnitRemoteClass(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType) Method resolves the unit remote class of the given unit type.
<R extends AbstractUnitRemote> R	newInitializedInstance(rst.rsb.ScopeType.Scope scope, Class<R> unitRemoteClass) Creates and initializes an unit remote out of the given unit scope and class type.
UnitRemote	newInitializedInstance(rst.rsb.ScopeType.Scope scope, long timeout, TimeUnit timeUnit) Creates and initializes an unit remote out of the given unit scope.
UnitRemote	newInitializedInstance(rst.rsb.ScopeType.Scope scope, rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type) Creates and initializes an unit remote out of the given unit scope and type declaration.
UnitRemote	newInitializedInstance(String unitId, long timeout, TimeUnit timeUnit) Creates and initializes an unit remote out of the given unit id.
UnitRemote	newInitializedInstance(rst.domotic.unit.UnitConfigType.UnitConfig config) Creates and initializes an unit remote out of the given unit configuration.
<R extends AbstractUnitRemote> R	newInstance(Class<R> unitRemoteClass) Creates an unit remote out of the given unit class.
UnitRemote	newInstance(rst.rsb.ScopeType.Scope scope, long timeout, TimeUnit timeUnit) Creates an unit remote out of the given unit scope.
UnitRemote	newInstance(String unitId, long timeout, TimeUnit timeUnit) Creates an unit remote out of the given unit id.
UnitRemote	newInstance(rst.domotic.unit.UnitConfigType.UnitConfig config) Creates an unit remote out of the given unit configuration.
UnitRemote	newInstance(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type) Creates an unit remote out of the given unit configuration.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static UnitRemoteFactory getInstance()

Method returns a new singelton instance of the unit factory.

Returns:

createUnitRemote

@Deprecated
public AbstractUnitRemote createUnitRemote(rst.domotic.unit.UnitConfigType.UnitConfig config)
                                                throws org.openbase.jul.exception.CouldNotPerformException

Deprecated. use newInstance instead!

Creates an unit remote out of the given unit configuration.

Specified by:

createUnitRemote in interface UnitRemoteFactory

Parameters:

config - the unit configuration which defines the remote type.

Returns:

the new created unit remote.

Throws:

org.openbase.jul.exception.CouldNotPerformException

createAndInitUnitRemote

@Deprecated
public AbstractUnitRemote createAndInitUnitRemote(rst.domotic.unit.UnitConfigType.UnitConfig config)
                                                       throws org.openbase.jul.exception.CouldNotPerformException

Deprecated.

Creates and initializes an unit remote out of the given unit configuration.

Specified by:

createAndInitUnitRemote in interface UnitRemoteFactory

Parameters:

config - the unit configuration which defines the remote type and is used for the remote initialization.

Returns:

the new created unit remote.

Throws:

org.openbase.jul.exception.CouldNotPerformException

org.openbase.jul.exception.InitializationException - * @deprecated use newInitializedInstance instead!

loadUnitRemoteClass

public static Class<? extends AbstractUnitRemote> loadUnitRemoteClass(rst.domotic.unit.UnitConfigType.UnitConfig config)
                                                               throws org.openbase.jul.exception.CouldNotPerformException

Method resolves the unit remote class of the given unit config.

Parameters:

config - the unit config to detect the unit class.

Returns:

the unit remote class is returned.

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown if something went wrong during class loading.

loadUnitRemoteClass

public static Class<? extends AbstractUnitRemote> loadUnitRemoteClass(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType)
                                                               throws org.openbase.jul.exception.CouldNotPerformException

Method resolves the unit remote class of the given unit type.

Parameters:

unitType - the unit type to detect the unit class.

Returns:

the unit remote class is returned.

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown if something went wrong during class loading.

newInstance

public UnitRemote newInstance(rst.domotic.unit.UnitConfigType.UnitConfig config)
                       throws org.openbase.jul.exception.InstantiationException

Creates an unit remote out of the given unit configuration.

Specified by:

newInstance in interface UnitRemoteFactory

Specified by:

newInstance in interface org.openbase.jul.pattern.Factory<UnitRemote,rst.domotic.unit.UnitConfigType.UnitConfig>

Parameters:

config - the unit configuration which defines the remote type.

Returns:

the new created unit remote.

Throws:

org.openbase.jul.exception.InstantiationException

newInstance

public <R extends AbstractUnitRemote> R newInstance(Class<R> unitRemoteClass)
                                             throws org.openbase.jul.exception.InstantiationException

Creates an unit remote out of the given unit class.

Specified by:

newInstance in interface UnitRemoteFactory

Type Parameters:

R - the unit remote class type.

Parameters:

unitRemoteClass - the unit class which defines the remote type.

Returns:

the new created unit remote.

Throws:

org.openbase.jul.exception.InstantiationException

newInstance

public UnitRemote newInstance(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type)
                       throws org.openbase.jul.exception.InstantiationException

Creates an unit remote out of the given unit configuration.

Specified by:

newInstance in interface UnitRemoteFactory

Parameters:

type - the unit type which is used for the remote initialization.

Returns:

the new created and initialized unit remote.

Throws:

org.openbase.jul.exception.InstantiationException - is thrown if the unit could not be instantiated with the given information.

newInstance

public UnitRemote newInstance(String unitId,
                              long timeout,
                              TimeUnit timeUnit)
                       throws org.openbase.jul.exception.InstantiationException,
                              org.openbase.jul.exception.CouldNotPerformException,
                              InterruptedException

Creates an unit remote out of the given unit id.

Specified by:

newInstance in interface UnitRemoteFactory

Parameters:

unitId - the unit id which defines the remote type.

timeout - the timeout for the unit registry lookup.

timeUnit - the time unit of the timeout.

Returns:

the new created unit remote.

Throws:

org.openbase.jul.exception.InstantiationException - is thrown if the unit could not be instantiated with the given information.

InterruptedException - is thrown if the thread was externally interrupted.

org.openbase.jul.exception.CouldNotPerformException

newInstance

public UnitRemote newInstance(rst.rsb.ScopeType.Scope scope,
                              long timeout,
                              TimeUnit timeUnit)
                       throws org.openbase.jul.exception.InstantiationException,
                              org.openbase.jul.exception.CouldNotPerformException,
                              InterruptedException

Creates an unit remote out of the given unit scope.

Specified by:

newInstance in interface UnitRemoteFactory

Parameters:

scope - the unit scope which defines the remote type..

timeout - the timeout for the unit registry lookup.

timeUnit - the time unit of the timeout.

Returns:

the new created unit remote.

Throws:

org.openbase.jul.exception.InstantiationException - is thrown if the unit could not be instantiated with the given information.

InterruptedException - is thrown if the thread was externally interrupted.

org.openbase.jul.exception.CouldNotPerformException

newInitializedInstance

public UnitRemote newInitializedInstance(rst.domotic.unit.UnitConfigType.UnitConfig config)
                                  throws org.openbase.jul.exception.InitializationException,
                                         org.openbase.jul.exception.InstantiationException,
                                         InterruptedException

Creates and initializes an unit remote out of the given unit configuration.

Specified by:

newInitializedInstance in interface UnitRemoteFactory

Parameters:

config - the unit configuration which defines the remote type and is used for the remote initialization.

Returns:

the new created unit remote.

Throws:

org.openbase.jul.exception.InitializationException

org.openbase.jul.exception.InstantiationException

InterruptedException

newInitializedInstance

public UnitRemote newInitializedInstance(rst.rsb.ScopeType.Scope scope,
                                         rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type)
                                  throws org.openbase.jul.exception.InitializationException,
                                         org.openbase.jul.exception.InstantiationException,
                                         InterruptedException

Creates and initializes an unit remote out of the given unit scope and type declaration.

Specified by:

newInitializedInstance in interface UnitRemoteFactory

Parameters:

scope - the unit scope which is used for the remote initialization.

type - the unit to instantiate.

Returns:

the new created unit remote.

Throws:

org.openbase.jul.exception.InitializationException - is thrown if the unit could not be initialized with the given information.

org.openbase.jul.exception.InstantiationException - is thrown if the unit could not be instantiated with the given information.

InterruptedException - is thrown if the thread was externally interrupted.

newInitializedInstance

public <R extends AbstractUnitRemote> R newInitializedInstance(rst.rsb.ScopeType.Scope scope,
                                                               Class<R> unitRemoteClass)
                                                        throws org.openbase.jul.exception.InitializationException,
                                                               org.openbase.jul.exception.InstantiationException,
                                                               InterruptedException

Creates and initializes an unit remote out of the given unit scope and class type.

Specified by:

newInitializedInstance in interface UnitRemoteFactory

Type Parameters:

R - the unit remote class type.

Parameters:

scope - the unit scope which is used for the remote initialization.

unitRemoteClass - to identify the unit type.

Returns:

the new created and initialized unit remote.

Throws:

org.openbase.jul.exception.InitializationException - is thrown if the unit could not be initialized with the given information.

org.openbase.jul.exception.InstantiationException - is thrown if the unit could not be instantiated with the given information.

InterruptedException - is thrown if the thread was externally interrupted. is thrown if the thread was externally interrupted.

newInitializedInstance

public UnitRemote newInitializedInstance(rst.rsb.ScopeType.Scope scope,
                                         long timeout,
                                         TimeUnit timeUnit)
                                  throws org.openbase.jul.exception.InitializationException,
                                         org.openbase.jul.exception.InstantiationException,
                                         org.openbase.jul.exception.CouldNotPerformException,
                                         InterruptedException

Creates and initializes an unit remote out of the given unit scope.

Specified by:

newInitializedInstance in interface UnitRemoteFactory

Parameters:

scope - the unit scope which is used for the remote initialization.

timeout - the timeout for the unit registry lookup.

timeUnit - the time unit of the timeout.

Returns:

the new created and initialized unit remote.

Throws:

org.openbase.jul.exception.InitializationException - is thrown if the unit could not be initialized with the given information.

org.openbase.jul.exception.InstantiationException - is thrown if the unit could not be instantiated with the given information.

org.openbase.jul.exception.CouldNotPerformException - is thrown if any other error occurs during buildup.

InterruptedException - is thrown if the thread was externally interrupted. is thrown if the thread was externally interrupted.

newInitializedInstance

public UnitRemote newInitializedInstance(String unitId,
                                         long timeout,
                                         TimeUnit timeUnit)
                                  throws org.openbase.jul.exception.InitializationException,
                                         org.openbase.jul.exception.InstantiationException,
                                         org.openbase.jul.exception.CouldNotPerformException,
                                         InterruptedException

Creates and initializes an unit remote out of the given unit id.

Specified by:

newInitializedInstance in interface UnitRemoteFactory

Parameters:

unitId - the unit id which is used for the remote initialization.

timeout - the timeout for the unit registry lookup.

timeUnit - the time unit of the timeout.

Returns:

the new created and initialized unit remote.

Throws:

org.openbase.jul.exception.InitializationException - is thrown if the unit could not be initialized with the given information.

org.openbase.jul.exception.InstantiationException - is thrown if the unit could not be instantiated with the given information.

org.openbase.jul.exception.CouldNotPerformException - is thrown if any other error occurs during buildup.

InterruptedException - is thrown if the thread was externally interrupted.