com.helger.commons.scope

Class AbstractMapBasedScope

java.lang.Object

com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

com.helger.commons.collection.attr.MapBasedAttributeContainer<KEYTYPE,Object>

com.helger.commons.collection.attr.MapBasedAttributeContainerAny<String>

com.helger.commons.scope.AbstractMapBasedScope

All Implemented Interfaces:

IAttributeContainer<String,Object>, IMutableAttributeContainer<String,Object>, IMutableAttributeContainerAny<String>, ICommonsIterable<Map.Entry<String,Object>>, IHasID<String>, ICloneable<MapBasedAttributeContainer<String,Object>>, IScope, IClearable, Serializable, Iterable<Map.Entry<String,Object>>

Direct Known Subclasses:

ApplicationScope, GlobalScope, RequestScope, SessionApplicationScope, SessionScope

@ThreadSafe
public abstract class AbstractMapBasedScope
extends MapBasedAttributeContainerAny<String>
implements IScope

Abstract scope implementation based on a Map containing the attribute values.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected SimpleReadWriteLock	m_aRWLock

Fields inherited from class com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer

m_aAttrs

Constructor Summary

Constructors

Constructor and Description
AbstractMapBasedScope(String sScopeID) Ctor.

Method Summary

Modifier and Type	Method and Description
protected void	destroyOwnedScopes() Override this method to destroy all scopes owned by this scope.
void	destroyScope() Destroys the scopes and all child scopes.
boolean	equals(Object o)
ICommonsMap<String,IScopeRenewalAware>	getAllScopeRenewalAwareAttributes()
String	getID() Get the ID of this scope.
int	hashCode()
boolean	isDestroyed()
boolean	isInDestruction()
boolean	isInPreDestruction()
boolean	isValid()
protected void	postDestroy() Override this method to perform further actions AFTER the scope was destroyed.
protected void	preDestroy() Override this method to perform further actions BEFORE the scope is destroyed.
void	runAtomic(Consumer<IScope> aConsumer) Perform stuff as a single action.
<T> T	runAtomic(Function<IScope,T> aFunction) Perform stuff as a single action.
String	toString()

Methods inherited from class com.helger.commons.collection.attr.MapBasedAttributeContainerAny

getClone

Methods inherited from class com.helger.commons.collection.attr.MapBasedAttributeContainer

clear, onBeforeRemoveAllAttributes, onBeforeRemoveAttribute, onBeforeSetAttributeValue, removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from class com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer

containsAttribute, forAllAttributes, forAllAttributeValues, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeCount, getAttributeObject, isEmpty, iterator

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.scope.IScope

initScope

Methods inherited from interface com.helger.commons.collection.attr.IMutableAttributeContainerAny

getAndSetAttributeFlag, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from interface com.helger.commons.collection.attr.IMutableAttributeContainer

computeIfAbsent, removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from interface com.helger.commons.collection.attr.IAttributeContainer

containsAttribute, forAllAttributes, forAllAttributeValues, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getAttributeCount, getAttributeObject, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute, isEmpty, isNotEmpty, iterator

Methods inherited from interface com.helger.commons.collection.ext.ICommonsIterable

containsAny, containsNone, containsOnly, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findAllMapped, findFirst, findFirst, findFirstMapped, findFirstMapped, forEach, forEach, forEachBreakable, getIteratorCount, getIteratorCount

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.helger.commons.state.IClearable

clear

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID

Field Detail

m_aRWLock

protected final SimpleReadWriteLock m_aRWLock

Constructor Detail

AbstractMapBasedScope

public AbstractMapBasedScope(@Nonnull @Nonempty
                             String sScopeID)

Ctor.

Parameters:

sScopeID - The scope ID. May neither be null nor empty.

Method Detail

getID

@Nonnull
 @Nonempty
public final String getID()

Description copied from interface: IScope

Get the ID of this scope. Each scope retrieves a unique ID within its type of scope (request, session, application). This method needs to be callable anytime and should not throw any exception!

Specified by:

getID in interface IHasID<String>

Specified by:

getID in interface IScope

Returns:

the non-null ID of this context.

isValid

public final boolean isValid()

Specified by:

isValid in interface IScope

Returns:

true if this scope is neither in destruction nor destroyed.

See Also:

IScope.isInDestruction(), IScope.isDestroyed()

isInPreDestruction

public final boolean isInPreDestruction()

isInDestruction

public final boolean isInDestruction()

Specified by:

isInDestruction in interface IScope

Returns:

true if the scope is currently in the process of destruction.

isDestroyed

public final boolean isDestroyed()

Specified by:

isDestroyed in interface IScope

Returns:

true if the scope was already destroyed. This is especially important for long running scopes.

preDestroy

@OverrideOnDemand
protected void preDestroy()

Override this method to perform further actions BEFORE the scope is destroyed. The state is "in pre destruction".

destroyOwnedScopes

@OverrideOnDemand
protected void destroyOwnedScopes()

Override this method to destroy all scopes owned by this scope.

postDestroy

@OverrideOnDemand
protected void postDestroy()

Override this method to perform further actions AFTER the scope was destroyed. The state is "destroyed".

destroyScope

public final void destroyScope()

Description copied from interface: IScope

Destroys the scopes and all child scopes. This method is only automatically called, when a scope goes out of scope.

Specified by:

destroyScope in interface IScope

runAtomic

public final void runAtomic(@Nonnull
                            Consumer<IScope> aConsumer)

Description copied from interface: IScope

Perform stuff as a single action. All actions are executed in a write-lock!

Specified by:

runAtomic in interface IScope

Parameters:

aConsumer - The consumer to be executed. May not be null. The parameter to the runnable is this scope.

runAtomic

@Nullable
public final <T> T runAtomic(@Nonnull
                                        Function<IScope,T> aFunction)

Description copied from interface: IScope

Perform stuff as a single action. All actions are executed in a write-lock!

Specified by:

runAtomic in interface IScope

Type Parameters:

T - The return type of the callable

Parameters:

aFunction - The function to be executed. May not be null. The parameter to the callable is this scope.

Returns:

The result from the callable. May be null.

getAllScopeRenewalAwareAttributes

@Nonnull
 @ReturnsMutableCopy
public final ICommonsMap<String,IScopeRenewalAware> getAllScopeRenewalAwareAttributes()

Specified by:

getAllScopeRenewalAwareAttributes in interface IScope

Returns:

The non-null map with all contained attributes that implement the IScopeRenewalAware interface. May be empty.

equals

public boolean equals(Object o)

Overrides:

equals in class MapBasedAttributeContainer<String,Object>

hashCode

public int hashCode()

Overrides:

hashCode in class MapBasedAttributeContainer<String,Object>

toString

public String toString()

Overrides:

toString in class MapBasedAttributeContainer<String,Object>