Uses of Interface
org.uberfire.preferences.shared.PreferenceScope

Packages that use PreferenceScope

Package	Description
org.uberfire.preferences.shared
org.uberfire.preferences.shared.bean
org.uberfire.preferences.shared.impl

Uses of PreferenceScope in org.uberfire.preferences.shared

Methods in org.uberfire.preferences.shared that return PreferenceScope

Modifier and Type	Method	Description
PreferenceScope	PreferenceScope.childScope()	Child scope, a scope inside a scope.
PreferenceScope	PreferenceScopeFactory.cloneScope(PreferenceScope scope)	Clones the passed scope to a new instance.
PreferenceScope	PreferenceScopeFactory.createScope(String type)	Builds a new preference scope, that does not require a custom key.
PreferenceScope	PreferenceScopeFactory.createScope(String type, String key)	Builds a new preference scope, that requires a custom key.
PreferenceScope	PreferenceScopeFactory.createScope(String type, String key, PreferenceScope childScope)	Builds a new preference scope, that requires a custom key, and has the passed child scope.
PreferenceScope	PreferenceScopeFactory.createScope(String type, PreferenceScope childScope)	Builds a new preference scope, that does not require a custom key, and has the passed child scope.
PreferenceScope	PreferenceScopeFactory.createScope(PreferenceScope... scopes)	Builds a new preference scope, that contains the following ones as child scopes.
PreferenceScope	PreferenceScopeResolver.resolve(String... scopeTypes)	Returns a PreferenceScope that belongs to the resolution strategy hierarchy, based on the passed types.

Methods in org.uberfire.preferences.shared with parameters of type PreferenceScope

Modifier and Type	Method	Description
Map<String,Object>	PreferenceStore.all(PreferenceScope scope)	Retrieves all defined preferences from a specific scope.
Collection<String>	PreferenceStorage.allKeys(PreferenceScope scope)	Returns all preference keys defined in a specific scope.
PreferenceScope	PreferenceScopeFactory.cloneScope(PreferenceScope scope)	Clones the passed scope to a new instance.
PreferenceScope	PreferenceScopeFactory.createScope(String type, String key, PreferenceScope childScope)	Builds a new preference scope, that requires a custom key, and has the passed child scope.
PreferenceScope	PreferenceScopeFactory.createScope(String type, PreferenceScope childScope)	Builds a new preference scope, that does not require a custom key, and has the passed child scope.
PreferenceScope	PreferenceScopeFactory.createScope(PreferenceScope... scopes)	Builds a new preference scope, that contains the following ones as child scopes.
void	PreferenceStorage.delete(PreferenceScope scope, String key)	Deletes a preference, in a specific scope, if it exists.
boolean	PreferenceStorage.exists(PreferenceScope preferenceScope, String key)	Checks if a given preference key is defined in a certain scope.
<T> T	PreferenceStore.get(PreferenceScope scope, String key)	Retrieves a preference value from a specific scope.
<T> T	PreferenceStore.get(PreferenceScope scope, String key, T defaultValue)	Retrieves a preference value from a specific scope.
<T> void	PreferenceStore.put(PreferenceScope scope, String key, T value)	Stores a preference inside a specific scope.
<T> void	PreferenceStore.put(PreferenceScope scope, Map<String,T> valueByKey)	Stores several preferences inside a specific scope.
<T> void	PreferenceStore.putIfAbsent(PreferenceScope scope, String key, T value)	Stores a preference inside a specific scope, if it is not already defined in that scope.
<T> void	PreferenceStore.putIfAbsent(PreferenceScope scope, Map<String,T> valueByKey)	Stores several preferences inside a specific scope, if they are not already defined in that scope.
<T> T	PreferenceStorage.read(PreferenceScope preferenceScope, String key)	Tries to read a preference value from a specific scope.
void	PreferenceStore.remove(PreferenceScope scope, String key)	Removes a preference from a specific scope.
Map<String,Object>	PreferenceStore.search(PreferenceScope scope, Collection<String> keys)	Retrieves several preferences, which keys were passed, from a specific scope.
void	PreferenceScopeValidator.validate(PreferenceScope scope)	Checks if a scope is valid.
void	PreferenceStorage.write(PreferenceScope scope, String key, Object value)	(Over) Writes a preference value related to a preference key, for a specific scope.

Method parameters in org.uberfire.preferences.shared with type arguments of type PreferenceScope

Modifier and Type	Method	Description
Collection<String>	PreferenceStorage.allKeys(List<PreferenceScope> scopes)	Returns all preference keys defined in all passed scopes.
void	PreferenceStore.remove(List<PreferenceScope> scopes, String key)	Removes a preference from a list of scopes.

Uses of PreferenceScope in org.uberfire.preferences.shared.bean

Methods in org.uberfire.preferences.shared.bean with parameters of type PreferenceScope

Modifier and Type	Method	Description
default void	BasePreference.save(PreferenceScope customScope)	Saves the preference content recursively through its properties.
default void	BasePreference.save(PreferenceScope customScope, org.uberfire.mvp.Command successCallback, org.uberfire.mvp.ParameterizedCommand<Throwable> errorCallback)	Saves the preference content recursively through its properties.
default void	BasePreference.save(PreferenceScope customScope, org.uberfire.mvp.ParameterizedCommand<Throwable> errorCallback)	Saves the preference content recursively through its properties.
void	PreferenceBeanServerStore.save(Collection<BasePreferencePortable<? extends BasePreference<?>>> portablePreferences, PreferenceScope scope)	Saves all preferences passed, following the passed scope resolution strategy.
<U extends BasePreference<U>,T extends BasePreferencePortable<U>> void	PreferenceBeanServerStore.save(T portablePreference, PreferenceScope scope)	Saves all preference data, inside the passed scope.
void	PreferenceBeanStore.save(Collection<BasePreferencePortable<? extends BasePreference<?>>> portablePreferences, PreferenceScope scope, org.uberfire.mvp.Command successCallback, org.uberfire.mvp.ParameterizedCommand<Throwable> errorCallback)	Saves all preferences passed, following the passed scope resolution strategy.
<U extends BasePreference<U>,T extends BasePreferencePortable<U>> void	PreferenceBeanStore.save(T portablePreference, PreferenceScope scope, org.uberfire.mvp.Command successCallback, org.uberfire.mvp.ParameterizedCommand<Throwable> errorCallback)	Saves all preference data, following the passed scope resolution strategy.

Uses of PreferenceScope in org.uberfire.preferences.shared.impl

Classes in org.uberfire.preferences.shared.impl that implement PreferenceScope

Modifier and Type	Class	Description
class	PreferenceScopeImpl	Default portable implementation for a preference scope, containing a type (required), a key (required) and a child scope (optional).

Methods in org.uberfire.preferences.shared.impl that return PreferenceScope

Modifier and Type	Method	Description
PreferenceScope	PreferenceScopeImpl.childScope()
PreferenceScope	PreferenceScopeFactoryImpl.cloneScope(PreferenceScope scope)
PreferenceScope	PreferenceScopeFactoryImpl.createScope(String type)
PreferenceScope	PreferenceScopeFactoryImpl.createScope(String type, String key)
PreferenceScope	PreferenceScopeFactoryImpl.createScope(String type, String key, PreferenceScope childScope)
PreferenceScope	PreferenceScopeFactoryImpl.createScope(String type, PreferenceScope childScope)
PreferenceScope	PreferenceScopeFactoryImpl.createScope(PreferenceScope... scopes)
PreferenceScope	PreferenceScopeResolutionStrategyInfo.defaultScope()
PreferenceScope	DefaultPreferenceScopeResolutionStrategy.getDefaultScope(List<PreferenceScope> order)
PreferenceScope	PreferenceScopedValue.getScope()
PreferenceScope	DefaultPreferenceScopeResolver.resolve(String... scopeTypes)

Methods in org.uberfire.preferences.shared.impl that return types with arguments of type PreferenceScope

Modifier and Type	Method	Description
List<PreferenceScope>	PreferenceScopeResolutionStrategyInfo.order()

Methods in org.uberfire.preferences.shared.impl with parameters of type PreferenceScope

Modifier and Type	Method	Description
PreferenceScope	PreferenceScopeFactoryImpl.cloneScope(PreferenceScope scope)
PreferenceScope	PreferenceScopeFactoryImpl.createScope(String type, String key, PreferenceScope childScope)
PreferenceScope	PreferenceScopeFactoryImpl.createScope(String type, PreferenceScope childScope)
PreferenceScope	PreferenceScopeFactoryImpl.createScope(PreferenceScope... scopes)
void	PreferenceScopeValidatorImpl.validate(PreferenceScope scope)

Method parameters in org.uberfire.preferences.shared.impl with type arguments of type PreferenceScope

Modifier and Type	Method	Description
PreferenceScope	DefaultPreferenceScopeResolutionStrategy.getDefaultScope(List<PreferenceScope> order)

Constructors in org.uberfire.preferences.shared.impl with parameters of type PreferenceScope

Constructor	Description
PreferenceScopedValue(T value, PreferenceScope scope)
PreferenceScopeImpl(String type, String key, PreferenceScope childScope)
PreferenceScopeResolutionStrategyInfo(List<PreferenceScope> order, PreferenceScope defaultScope)

Constructor parameters in org.uberfire.preferences.shared.impl with type arguments of type PreferenceScope

Constructor	Description
DefaultPreferenceScopeResolver(List<PreferenceScope> order)
PreferenceScopeResolutionStrategyInfo(List<PreferenceScope> order, PreferenceScope defaultScope)