Package com.helger.web.scope.singleton

Class AbstractGlobalWebSingleton

java.lang.Object

com.helger.scope.singleton.AbstractSingleton

com.helger.web.scope.singleton.AbstractGlobalWebSingleton

All Implemented Interfaces:

com.helger.scope.IScopeDestructionAware, IWebSingleton

Direct Known Subclasses:

GlobalDiskFileItemFactory

public abstract class AbstractGlobalWebSingleton
extends com.helger.scope.singleton.AbstractSingleton
implements IWebSingleton

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:

EWebScope.GLOBAL

Field Summary

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

m_aRWLock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractGlobalWebSingleton()

Method Summary

Modifier and Type	Method	Description
static com.helger.commons.collection.impl.ICommonsList<AbstractGlobalWebSingleton>	getAllGlobalSingletons()	Get all singleton objects registered in the current global web scope.
static <T extends AbstractGlobalWebSingleton> T	getGlobalSingleton(Class<T> aClass)	Get the singleton object in the current global web scope, using the passed class.
static <T extends AbstractGlobalWebSingleton> T	getGlobalSingletonIfInstantiated(Class<T> aClass)	Get the singleton object if it is already instantiated inside the current global web scope or null if it is not instantiated.
static boolean	isGlobalSingletonInstantiated(Class<? extends AbstractGlobalWebSingleton> aClass)	Check if a singleton is already instantiated inside the current global web scope

Methods inherited from class com.helger.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

AbstractGlobalWebSingleton

protected AbstractGlobalWebSingleton()

Method Detail

getGlobalSingleton

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

Get the singleton object in the current global web 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 AbstractGlobalWebSingleton> T getGlobalSingletonIfInstantiated(@Nonnull
                                                                                              Class<T> aClass)

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

Check if a singleton is already instantiated inside the current global web 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
public static final com.helger.commons.collection.impl.ICommonsList<AbstractGlobalWebSingleton> getAllGlobalSingletons()

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

Returns:

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