com.helger.commons.scopes.singleton

Class SessionApplicationSingleton

java.lang.Object

com.helger.commons.scopes.AbstractSingleton

com.helger.commons.scopes.singleton.SessionApplicationSingleton

All Implemented Interfaces:

IScopeDestructionAware, Serializable

Direct Known Subclasses:

SessionApplicationSingletonTreeWithUniqueID

@MustImplementEqualsAndHashcode
public abstract class SessionApplicationSingleton
extends AbstractSingleton
implements Serializable

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

Author:

Philip Helger

See Also:

EScope.SESSION_APPLICATION, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SessionApplicationSingleton()

Method Summary

Methods

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

Methods inherited from class com.helger.commons.scopes.AbstractSingleton

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionApplicationSingleton

protected SessionApplicationSingleton()

Method Detail

getSessionApplicationSingleton

@Nonnull
public static final <T extends SessionApplicationSingleton> T getSessionApplicationSingleton(@Nonnull
                                                                               Class<T> aClass)

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

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.

getSessionApplicationSingletonIfInstantiated

@Nullable
public static final <T extends SessionApplicationSingleton> T getSessionApplicationSingletonIfInstantiated(@Nonnull
                                                                                              Class<T> aClass)

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

Parameters:

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

Returns:

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

isSessionApplicationSingletonInstantiated

public static final boolean isSessionApplicationSingletonInstantiated(@Nonnull
                                                Class<? extends SessionApplicationSingleton> aClass)

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

getAllSessionApplicationSingletons

@Nonnull
public static final List<SessionApplicationSingleton> getAllSessionApplicationSingletons()

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

Returns:

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