com.helger.commons.scope

Interface IGlobalScope

All Superinterfaces:

IAttributeContainer<String,Object>, IClearable, IHasID<String>, IMutableAttributeContainer<String,Object>, IMutableAttributeContainerAny<String>, IScope, Serializable

All Known Implementing Classes:

GlobalScope

public interface IGlobalScope
extends IScope

Interface for a single global scope object.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,IApplicationScope>	getAllApplicationScopes()
IApplicationScope	getApplicationScope(String sAppID, boolean bCreateIfNotExisting) Get or create an application scope with the given ID.
int	getApplicationScopeCount()

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

destroyScope, getAllScopeRenewalAwareAttributes, getID, initScope, isDestroyed, isInDestruction, isValid, runAtomic, runAtomic

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

removeAttribute, setAttribute, setAttributes, setAttributes

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

containsAttribute, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getAttributeCount, getAttributeObject, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute

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

clear

Method Detail

getApplicationScope

@Nullable
IApplicationScope getApplicationScope(@Nonnull@Nonempty
                                             String sAppID,
                                             boolean bCreateIfNotExisting)

Get or create an application scope with the given ID.

Parameters:

sAppID - The ID of the application scope to create. May neither be null nor empty.

bCreateIfNotExisting - if true the scope is created on first demand if it is not yet existing.

Returns:

null if bCreateIfNotExisting is false and the scope is not present

getAllApplicationScopes

@Nonnull
Map<String,IApplicationScope> getAllApplicationScopes()

Returns:

A non-null map with all available application scopes. The key is the application ID and the value is the scope.

getApplicationScopeCount

@Nonnegative
int getApplicationScopeCount()

Returns:

The number of contained application scopes. Always ≥ 0.