Package com.helger.web.scope.singleton

Class AbstractSessionWebSingleton

java.lang.Object

com.helger.scope.singleton.AbstractSingleton

com.helger.web.scope.singleton.AbstractSessionWebSingleton

All Implemented Interfaces:

com.helger.scope.IScopeDestructionAware, IWebSingleton

@MustImplementEqualsAndHashcode
public abstract class AbstractSessionWebSingleton
extends com.helger.scope.singleton.AbstractSingleton
implements IWebSingleton

This is the base class for singleton objects that reside in the session web scope.

Author:

Philip Helger

See Also:

EWebScope.SESSION

Field Summary

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

m_aRWLock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSessionWebSingleton()

Method Summary

Modifier and Type	Method	Description
static com.helger.commons.collection.impl.ICommonsList<AbstractSessionWebSingleton>	getAllSessionSingletons()	Get all singleton objects registered in the current session web scope.
static <T extends AbstractSessionWebSingleton> T	getSessionSingleton(Class<T> aClass)	Get the singleton object in the current session web scope, using the passed class.
static <T extends AbstractSessionWebSingleton> T	getSessionSingletonIfInstantiated(Class<T> aClass)	Get the singleton object if it is already instantiated inside the current session web scope or null if it is not instantiated.
static boolean	isSessionSingletonInstantiated(Class<? extends AbstractSessionWebSingleton> aClass)	Check if a singleton is already instantiated inside the current session 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

AbstractSessionWebSingleton

protected AbstractSessionWebSingleton()

Method Detail

getSessionSingleton

@Nonnull
public static final <T extends AbstractSessionWebSingleton> T getSessionSingleton(@Nonnull
                                                                                  Class<T> aClass)

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

getSessionSingletonIfInstantiated

@Nullable
public static final <T extends AbstractSessionWebSingleton> T getSessionSingletonIfInstantiated(@Nonnull
                                                                                                Class<T> aClass)

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

isSessionSingletonInstantiated

public static final boolean isSessionSingletonInstantiated(@Nonnull
                                                           Class<? extends AbstractSessionWebSingleton> aClass)

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

getAllSessionSingletons

@Nonnull
public static final com.helger.commons.collection.impl.ICommonsList<AbstractSessionWebSingleton> getAllSessionSingletons()

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

Returns:

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