com.helger.commons.scope.singleton

Class AbstractApplicationSingleton

java.lang.Object

com.helger.commons.scope.singleton.AbstractSingleton

com.helger.commons.scope.singleton.AbstractApplicationSingleton

All Implemented Interfaces:

IScopeDestructionAware

Direct Known Subclasses:

AbstractApplicationSingletonTreeWithUniqueID

public abstract class AbstractApplicationSingleton
extends AbstractSingleton

This is the base class for singleton objects that reside in the application scope. This is the same for web scopes and non-web scopes, as application scopes are managed in the global scope which is also identical for web scopes and non-web scopes.

Author:

Philip Helger

See Also:

EScope.APPLICATION

Field Summary

Fields inherited from class com.helger.commons.scope.singleton.AbstractSingleton

m_aRWLock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractApplicationSingleton()

Method Summary

Modifier and Type	Method and Description
static List<AbstractApplicationSingleton>	getAllApplicationSingletons() Get all instantiated singleton objects registered in the current application scope.
static <T extends AbstractApplicationSingleton> T	getApplicationSingleton(Class<T> aClass) Get the singleton object in the current application scope, using the passed class.
static <T extends AbstractApplicationSingleton> T	getApplicationSingletonIfInstantiated(Class<T> aClass) Get the singleton object if it is already instantiated inside the current application scope or null if it is not instantiated.
static boolean	isApplicationSingletonInstantiated(Class<? extends AbstractApplicationSingleton> aClass) Check if a singleton is already instantiated inside the current application scope

Methods inherited from class com.helger.commons.scope.singleton.AbstractSingleton

getAllSingletons, getSingleton, getSingletonIfInstantiated, getSingletonScopeKey, isDestroyed, isInDestruction, isInInstantiation, isInPreDestruction, isInstantiated, isSingletonInstantiated, isUsableObject, onAfterInstantiation, onBeforeDestroy, onBeforeScopeDestruction, onDestroy, onScopeDestruction, readAbstractSingletonFields, setDestroyed, setInDestruction, setInInstantiation, setInPreDestruction, setInstantiated, toString, writeAbstractSingletonFields

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractApplicationSingleton

protected AbstractApplicationSingleton()

Method Detail

getApplicationSingleton

@Nonnull
public static final <T extends AbstractApplicationSingleton> T getApplicationSingleton(@Nonnull
                                                                                                 Class<T> aClass)

Get the singleton object in the current application scope, using the passed class. If the singleton is not yet instantiated, a new instance is created.

Type Parameters:

T - The type to be returned

Parameters:

aClass - The class to be used. May not be null. The class must be public as needs to have a public no-argument constructor.

Returns:

The singleton object and never null.

getApplicationSingletonIfInstantiated

@Nullable
public static final <T extends AbstractApplicationSingleton> T getApplicationSingletonIfInstantiated(@Nonnull
                                                                                                                Class<T> aClass)

Get the singleton object if it is already instantiated inside the current application scope or null if it is not instantiated.

Type Parameters:

T - The type to be returned

Parameters:

aClass - The class to be checked. May not be null.

Returns:

The singleton for the specified class is already instantiated, null otherwise.

isApplicationSingletonInstantiated

public static final boolean isApplicationSingletonInstantiated(@Nonnull
                                                               Class<? extends AbstractApplicationSingleton> aClass)

Check if a singleton is already instantiated inside the current application scope

Parameters:

aClass - The class to be checked. May not be null.

Returns:

true if the singleton for the specified class is already instantiated, false otherwise.

getAllApplicationSingletons

@Nonnull
 @ReturnsMutableCopy
public static final List<AbstractApplicationSingleton> getAllApplicationSingletons()

Get all instantiated singleton objects registered in the current application scope.

Returns:

A non-null list with all instances of this class in the current application scope.