com.helger.commons.scope.singleton

Class AbstractGlobalSingleton

java.lang.Object

com.helger.commons.scope.singleton.AbstractSingleton

com.helger.commons.scope.singleton.AbstractGlobalSingleton

All Implemented Interfaces:

IScopeDestructionAware

Direct Known Subclasses:

AbstractGlobalSingletonTreeWithUniqueID, ScopedFileMonitorManager, ScopeSessionManager

public abstract class AbstractGlobalSingleton
extends AbstractSingleton

This is the base class for singleton objects that reside in the global scope. The global scope is identical for web scope and non-web scope applications.

Author:

Philip Helger

See Also:

EScope.GLOBAL

Field Summary

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

m_aRWLock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGlobalSingleton()

Method Summary

Modifier and Type	Method and Description
static List<AbstractGlobalSingleton>	getAllGlobalSingletons() Get all instantiated singleton objects registered in the current global scope.
static <T extends AbstractGlobalSingleton> T	getGlobalSingleton(Class<T> aClass) Get the singleton object in the current global scope, using the passed class.
static <T extends AbstractGlobalSingleton> T	getGlobalSingletonIfInstantiated(Class<T> aClass) Get the singleton object if it is already instantiated inside the current global scope or null if it is not instantiated.
static boolean	isGlobalSingletonInstantiated(Class<? extends AbstractGlobalSingleton> aClass) Check if a singleton is already instantiated inside the current global 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

AbstractGlobalSingleton

protected AbstractGlobalSingleton()

Method Detail

getGlobalSingleton

@Nonnull
public static final <T extends AbstractGlobalSingleton> T getGlobalSingleton(@Nonnull
                                                                                       Class<T> aClass)

Get the singleton object in the current global 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.

getGlobalSingletonIfInstantiated

@Nullable
public static final <T extends AbstractGlobalSingleton> T getGlobalSingletonIfInstantiated(@Nonnull
                                                                                                      Class<T> aClass)

Get the singleton object if it is already instantiated inside the current global 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.

isGlobalSingletonInstantiated

public static final boolean isGlobalSingletonInstantiated(@Nonnull
                                                          Class<? extends AbstractGlobalSingleton> aClass)

Check if a singleton is already instantiated inside the current global 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.

getAllGlobalSingletons

@Nonnull
 @ReturnsMutableCopy
public static final List<AbstractGlobalSingleton> getAllGlobalSingletons()

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

Returns:

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