Skip navigation links
Uberfire Preferences API 2.11.0.Final-redhat-00002
A B C D E F G H I K L N O P R S T U V W 

A

addPropertyBundleKey(String, String) - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
addPropertyFormOptions(String, PropertyFormOptions[]) - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
addPropertyHelpBundleKey(String, String) - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
all(PreferenceScope) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves all defined preferences from a specific scope.
all(PreferenceScopeResolutionStrategyInfo) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves all defined preferences.
all() - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves all defined preferences.
allKeys(PreferenceScope) - Method in interface org.uberfire.preferences.shared.PreferenceStorage
Returns all preference keys defined in a specific scope.
allKeys(List<PreferenceScope>) - Method in interface org.uberfire.preferences.shared.PreferenceStorage
Returns all preference keys defined in all passed scopes.
allScoped(PreferenceScopeResolutionStrategyInfo) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves all defined preferences.
allScoped() - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves all defined preferences.

B

BasePreference<T> - Interface in org.uberfire.preferences.shared.bean
Interface that all preference beans should implement.
BasePreferenceBean<T> - Interface in org.uberfire.preferences.shared.bean
Represents a generated managed bean implementation of a preference bean.
BasePreferencePortable<T> - Interface in org.uberfire.preferences.shared.bean
Represents a generated portable implementation of a preference bean.
buildHierarchyStructureForPreference(String) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanServerStore
Builds a tree hierarchy that begins with the root preference bean which identifier was passed and grows based on their sub-preferences.
buildHierarchyStructureForPreference(String, PreferenceScopeResolutionStrategyInfo) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanServerStore
Builds a tree hierarchy that begins with the root preference bean which identifier was passed and grows based on their sub-preferences.
bundleKey() - Method in interface org.uberfire.preferences.shared.bean.BasePreferencePortable
Returns the bundle key registered in the WorkbenchPreference annotation.
bundleKey() - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockPortableGeneratedImpl
 

C

childScope() - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeImpl
 
childScope() - Method in interface org.uberfire.preferences.shared.PreferenceScope
Child scope, a scope inside a scope.
cloneScope(PreferenceScope) - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeFactoryImpl
 
cloneScope(PreferenceScope) - Method in interface org.uberfire.preferences.shared.PreferenceScopeFactory
Clones the passed scope to a new instance.
ConstrainedValuesValidator<T> - Class in org.uberfire.preferences.shared.impl.validation
 
ConstrainedValuesValidator(Supplier<Collection<T>>, Function<Object, T>) - Constructor for class org.uberfire.preferences.shared.impl.validation.ConstrainedValuesValidator
 
createScope(String) - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeFactoryImpl
 
createScope(String, PreferenceScope) - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeFactoryImpl
 
createScope(String, String) - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeFactoryImpl
 
createScope(String, String, PreferenceScope) - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeFactoryImpl
 
createScope(PreferenceScope...) - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeFactoryImpl
 
createScope(String) - Method in interface org.uberfire.preferences.shared.PreferenceScopeFactory
Builds a new preference scope, that does not require a custom key.
createScope(String, PreferenceScope) - Method in interface org.uberfire.preferences.shared.PreferenceScopeFactory
Builds a new preference scope, that does not require a custom key, and has the passed child scope.
createScope(String, String) - Method in interface org.uberfire.preferences.shared.PreferenceScopeFactory
Builds a new preference scope, that requires a custom key.
createScope(String, String, PreferenceScope) - Method in interface org.uberfire.preferences.shared.PreferenceScopeFactory
Builds a new preference scope, that requires a custom key, and has the passed child scope.
createScope(PreferenceScope...) - Method in interface org.uberfire.preferences.shared.PreferenceScopeFactory
Builds a new preference scope, that contains the following ones as child scopes.

D

DefaultPreferenceScopeResolutionStrategy - Class in org.uberfire.preferences.shared.impl
Default implementation for PreferenceScopeResolutionStrategy.
DefaultPreferenceScopeResolutionStrategy() - Constructor for class org.uberfire.preferences.shared.impl.DefaultPreferenceScopeResolutionStrategy
 
DefaultPreferenceScopeResolutionStrategy(PreferenceScopeFactory, String) - Constructor for class org.uberfire.preferences.shared.impl.DefaultPreferenceScopeResolutionStrategy
 
DefaultPreferenceScopeResolver - Class in org.uberfire.preferences.shared.impl
Default scope resolver for DefaultPreferenceScopeResolutionStrategy.
DefaultPreferenceScopeResolver(List<PreferenceScope>) - Constructor for class org.uberfire.preferences.shared.impl.DefaultPreferenceScopeResolver
 
DefaultPreferenceScopeTypes - Class in org.uberfire.preferences.shared.impl
Default implementation for PreferenceScopeTypes.
DefaultPreferenceScopeTypes() - Constructor for class org.uberfire.preferences.shared.impl.DefaultPreferenceScopeTypes
 
DefaultPreferenceScopeTypes(UsernameProvider) - Constructor for class org.uberfire.preferences.shared.impl.DefaultPreferenceScopeTypes
 
DefaultPreferenceScopeTypes.DefaultKey - Interface in org.uberfire.preferences.shared.impl
 
defaultScope() - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeResolutionStrategyInfo
 
DefaultScopes - Enum in org.uberfire.preferences.shared.impl
Definition of default scope types that can be used.
defaultValue(T) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Returns the default value of this preference object.
delete(PreferenceScope, String) - Method in interface org.uberfire.preferences.shared.PreferenceStorage
Deletes a preference, in a specific scope, if it exists.

E

EnumValuePropertyValidator<T extends Enum<?>> - Class in org.uberfire.preferences.shared.impl.validation
 
EnumValuePropertyValidator(T[]) - Constructor for class org.uberfire.preferences.shared.impl.validation.EnumValuePropertyValidator
 
equals(Object) - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockPortableGeneratedImpl
 
equals(Object) - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
equals(Object) - Method in class org.uberfire.preferences.shared.bean.PreferenceRootElement
 
equals(Object) - Method in class org.uberfire.preferences.shared.impl.PreferenceScopedValue
 
equals(Object) - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeImpl
 
equals(Object) - Method in class org.uberfire.preferences.shared.impl.validation.ValidationResult
 
exists(PreferenceScope, String) - Method in interface org.uberfire.preferences.shared.PreferenceStorage
Checks if a given preference key is defined in a certain scope.
exists(PreferenceScopeResolutionStrategyInfo, String) - Method in interface org.uberfire.preferences.shared.PreferenceStorage
Checks if a given preference key is defined in any scope of the provided hierarchy.

F

format(T) - Static method in class org.uberfire.preferences.shared.impl.validation.EnumValuePropertyValidator
 
fromString(String) - Method in enum org.uberfire.preferences.shared.PropertyFormType
 

G

get(String) - Method in interface org.uberfire.preferences.shared.bean.BasePreferencePortable
Returns a property value by its name.
get(String) - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockPortableGeneratedImpl
 
get() - Method in interface org.uberfire.preferences.shared.impl.DefaultPreferenceScopeTypes.DefaultKey
 
get(PreferenceScope, String) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves a preference value from a specific scope.
get(PreferenceScope, String, T) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves a preference value from a specific scope.
get(PreferenceScopeResolutionStrategyInfo, String) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves a preference value from the first scope of the scopeResolutionStrategy order that has the preference defined.
get(PreferenceScopeResolutionStrategyInfo, String, T) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves a preference value from the first scope of the scopeResolutionStrategy order that has the preference defined.
get(String) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves a preference value from the first scope of the default scope resolution strategy order that has the preference defined.
get(String, T) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves a preference value from the first scope of the default scope resolution strategy order that has the preference defined.
getBundleKey() - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
getBundleKey() - Method in class org.uberfire.preferences.shared.bean.PreferenceRootElement
 
getBundleKeyByProperty() - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
getCategory() - Method in class org.uberfire.preferences.shared.bean.PreferenceRootElement
 
getChildren() - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
getDefaultKeyFor(String) - Method in class org.uberfire.preferences.shared.impl.DefaultPreferenceScopeTypes
 
getDefaultKeyFor(String) - Method in interface org.uberfire.preferences.shared.PreferenceScopeTypes
Returns the default key for a type.
getDefaultScope(List<PreferenceScope>) - Method in class org.uberfire.preferences.shared.impl.DefaultPreferenceScopeResolutionStrategy
 
getDefaultScopeResolutionStrategyInfo() - Method in interface org.uberfire.preferences.shared.PreferenceStore
Provides a portable instance that has the scope resolution strategy order and the default scope for preference persistence.
getDefaultScopeResolver() - Method in interface org.uberfire.preferences.shared.PreferenceStore
Provides a portable instance that resolves scopes in the default scope resolution strategy order.
getFormOptionsByProperty() - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
getHelpBundleKeyByProperty() - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
getIconCss() - Method in class org.uberfire.preferences.shared.bean.PreferenceRootElement
 
getId() - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
getIdentifier() - Method in class org.uberfire.preferences.shared.bean.PreferenceRootElement
 
getInfo() - Method in class org.uberfire.preferences.shared.impl.DefaultPreferenceScopeResolutionStrategy
 
getInfo() - Method in interface org.uberfire.preferences.shared.PreferenceScopeResolutionStrategy
Defines the order of scopes that will be used when a preference value is searched, as well the scope where a preference will be persisted if none is provided.
getMessagesBundleKeys() - Method in class org.uberfire.preferences.shared.impl.validation.ValidationResult
 
getPojoClass() - Method in interface org.uberfire.preferences.shared.bean.BasePreferencePortable
Returns the preference bean class.
getPojoClass() - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockPortableGeneratedImpl
 
getPortablePreference() - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
getPropertiesTypes() - Method in interface org.uberfire.preferences.shared.bean.BasePreferencePortable
Returns the form types of all simple (non-preference) properties by their field name.
getPropertiesTypes() - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockPortableGeneratedImpl
 
getPropertiesValidators() - Method in interface org.uberfire.preferences.shared.bean.BasePreferencePortable
 
getPropertiesValidators() - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockPortableGeneratedImpl
 
getPropertyType(String) - Method in interface org.uberfire.preferences.shared.bean.BasePreferencePortable
Returns the form type of a specific simple (non-preference) property by its field name.
getPropertyValidators(String) - Method in interface org.uberfire.preferences.shared.bean.BasePreferencePortable
 
getScope() - Method in class org.uberfire.preferences.shared.impl.PreferenceScopedValue
 
getScoped(PreferenceScopeResolutionStrategyInfo, String) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves a scoped preference value from the first scope of the scopeResolutionStrategy order that has the preference defined.
getScoped(PreferenceScopeResolutionStrategyInfo, String, T) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves a scoped preference value from the first scope of the scopeResolutionStrategy order that has the preference defined.
getScoped(String) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves a preference value from the first scope of the default scope resolution strategy order that has the preference defined.
getScoped(String, T) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves a preference value from the first scope of the default scope resolution strategy order that has the preference defined.
getScopeResolver() - Method in class org.uberfire.preferences.shared.impl.DefaultPreferenceScopeResolutionStrategy
 
getScopeResolver() - Method in interface org.uberfire.preferences.shared.PreferenceScopeResolutionStrategy
Returns a scope resolver for this scope resolution strategy.
getValue() - Method in class org.uberfire.preferences.shared.impl.PreferenceScopedValue
 

H

hasChildren() - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
hashCode() - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockPortableGeneratedImpl
 
hashCode() - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
hashCode() - Method in class org.uberfire.preferences.shared.bean.PreferenceRootElement
 
hashCode() - Method in class org.uberfire.preferences.shared.impl.PreferenceScopedValue
 
hashCode() - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeImpl
 
hashCode() - Method in class org.uberfire.preferences.shared.impl.validation.ValidationResult
 

I

identifier() - Method in interface org.uberfire.preferences.shared.bean.BasePreferencePortable
Unique identifier, used by this preference children to determine their parents.
identifier() - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockPortableGeneratedImpl
 
InvalidPreferenceScopeException - Exception in org.uberfire.preferences.shared.impl.exception
Exception thrown when a invalid preference scope is used or created.
InvalidPreferenceScopeException() - Constructor for exception org.uberfire.preferences.shared.impl.exception.InvalidPreferenceScopeException
 
InvalidPreferenceScopeException(String) - Constructor for exception org.uberfire.preferences.shared.impl.exception.InvalidPreferenceScopeException
 
isEmpty(String) - Method in class org.uberfire.preferences.shared.impl.DefaultPreferenceScopeTypes
 
isEmpty(String) - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeValidatorImpl
 
isPersistable() - Method in interface org.uberfire.preferences.shared.bean.BasePreferencePortable
A preference is persistable when it has at least one non-shared property.
isPersistable() - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockPortableGeneratedImpl
 
isRoot() - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
isSelectable() - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
isShared() - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
isValid() - Method in class org.uberfire.preferences.shared.impl.validation.ValidationResult
 

K

key() - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeImpl
 
key() - Method in interface org.uberfire.preferences.shared.PreferenceScope
 

L

load() - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Loads the preference content recursively through its properties.
load(ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Loads the preference content recursively through its properties.
load(ParameterizedCommand<T>, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Loads the preference content recursively through its properties.
load(PreferenceScopeResolutionStrategyInfo) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Loads the preference content recursively through its properties.
load(PreferenceScopeResolutionStrategyInfo, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Loads the preference content recursively through its properties.
load(PreferenceScopeResolutionStrategyInfo, ParameterizedCommand<T>, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Loads the preference content recursively through its properties.
load() - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockBeanGeneratedImpl
 
load(ParameterizedCommand<Throwable>) - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockBeanGeneratedImpl
 
load(ParameterizedCommand<PortablePreferenceMock>, ParameterizedCommand<Throwable>) - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockBeanGeneratedImpl
 
load(PreferenceScopeResolutionStrategyInfo) - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockBeanGeneratedImpl
 
load(PreferenceScopeResolutionStrategyInfo, ParameterizedCommand<Throwable>) - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockBeanGeneratedImpl
 
load(PreferenceScopeResolutionStrategyInfo, ParameterizedCommand<PortablePreferenceMock>, ParameterizedCommand<Throwable>) - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockBeanGeneratedImpl
 
load(T) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanServerStore
Loads all preference bean properties.
load(T, PreferenceScopeResolutionStrategyInfo) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanServerStore
Loads all preference bean properties, following the passed scope resolution strategy.
load(T, ParameterizedCommand<T>, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanStore
Loads all preference bean properties.
load(T, PreferenceScopeResolutionStrategyInfo, ParameterizedCommand<T>, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanStore
Loads all preference bean properties, following the passed scope resolution strategy.

N

NotEmptyValidator - Class in org.uberfire.preferences.shared.impl.validation
 
NotEmptyValidator() - Constructor for class org.uberfire.preferences.shared.impl.validation.NotEmptyValidator
 

O

order() - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeResolutionStrategyInfo
 
org.uberfire.preferences.shared - package org.uberfire.preferences.shared
 
org.uberfire.preferences.shared.annotations - package org.uberfire.preferences.shared.annotations
 
org.uberfire.preferences.shared.bean - package org.uberfire.preferences.shared.bean
 
org.uberfire.preferences.shared.bean.mock - package org.uberfire.preferences.shared.bean.mock
 
org.uberfire.preferences.shared.impl - package org.uberfire.preferences.shared.impl
 
org.uberfire.preferences.shared.impl.exception - package org.uberfire.preferences.shared.impl.exception
 
org.uberfire.preferences.shared.impl.validation - package org.uberfire.preferences.shared.impl.validation
 

P

parents() - Method in interface org.uberfire.preferences.shared.bean.BasePreferencePortable
The preferences which will have this preference as their child.
parents() - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockPortableGeneratedImpl
 
parseString(Object) - Static method in class org.uberfire.preferences.shared.impl.validation.EnumValuePropertyValidator
 
PortablePreference - Annotation Type in org.uberfire.preferences.shared.annotations
Annotation used to qualify generated portable implementations of preference beans.
PortablePreferenceMock - Class in org.uberfire.preferences.shared.bean.mock
Created to be used in tests, and to avoid Errai errors due to unimplemented interfaces used in portable classes.
PortablePreferenceMock() - Constructor for class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMock
 
PortablePreferenceMockBeanGeneratedImpl - Class in org.uberfire.preferences.shared.bean.mock
 
PortablePreferenceMockBeanGeneratedImpl(PreferenceBeanStore) - Constructor for class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockBeanGeneratedImpl
 
PortablePreferenceMockPortableGeneratedImpl - Class in org.uberfire.preferences.shared.bean.mock
Created to be used in tests, and to avoid Errai errors due to unimplemented interfaces used in portable classes.
PortablePreferenceMockPortableGeneratedImpl() - Constructor for class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockPortableGeneratedImpl
 
PortablePreferenceMockPortableGeneratedImpl(String) - Constructor for class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockPortableGeneratedImpl
 
Preference - Interface in org.uberfire.preferences.shared.bean
Represents a preference class, generated or provided.
PreferenceBeanServerStore - Interface in org.uberfire.preferences.shared.bean
Service to manage preference beans.
PreferenceBeanStore - Interface in org.uberfire.preferences.shared.bean
Service to manage preference beans, with server-side and client-side implementations.
PreferenceHierarchyElement<T> - Class in org.uberfire.preferences.shared.bean
Holds all preference information necessary to build a hierarchic interface for preferences.
PreferenceHierarchyElement() - Constructor for class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
PreferenceHierarchyElement(String, BasePreferencePortable<T>, boolean, boolean, String) - Constructor for class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
PreferenceHierarchyElement(String, BasePreferencePortable<T>, List<PreferenceHierarchyElement<?>>, boolean, boolean, String, Map<String, String>, Map<String, String>, Map<String, PropertyFormOptions[]>) - Constructor for class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
PreferenceRootElement - Class in org.uberfire.preferences.shared.bean
 
PreferenceRootElement() - Constructor for class org.uberfire.preferences.shared.bean.PreferenceRootElement
 
PreferenceRootElement(String, String, String, String) - Constructor for class org.uberfire.preferences.shared.bean.PreferenceRootElement
 
PreferenceScope - Interface in org.uberfire.preferences.shared
The pair (type, key) represents a unique preference scope, which groups a set of preferences and its values.
PreferenceScopedValue<T> - Class in org.uberfire.preferences.shared.impl
Represents a preference value and its scope.
PreferenceScopedValue(T, PreferenceScope) - Constructor for class org.uberfire.preferences.shared.impl.PreferenceScopedValue
 
PreferenceScopeFactory - Interface in org.uberfire.preferences.shared
Builder for new preference scope creation.
PreferenceScopeFactoryImpl - Class in org.uberfire.preferences.shared.impl
 
PreferenceScopeFactoryImpl() - Constructor for class org.uberfire.preferences.shared.impl.PreferenceScopeFactoryImpl
 
PreferenceScopeFactoryImpl(PreferenceScopeTypes) - Constructor for class org.uberfire.preferences.shared.impl.PreferenceScopeFactoryImpl
 
PreferenceScopeImpl - Class in org.uberfire.preferences.shared.impl
Default portable implementation for a preference scope, containing a type (required), a key (required) and a child scope (optional).
PreferenceScopeImpl(String, String, PreferenceScope) - Constructor for class org.uberfire.preferences.shared.impl.PreferenceScopeImpl
 
PreferenceScopeResolutionStrategy - Interface in org.uberfire.preferences.shared
Defines the hierarchy used to resolve a preference value.
PreferenceScopeResolutionStrategyInfo - Class in org.uberfire.preferences.shared.impl
Holds all necessary information to the scope resolution strategy.
PreferenceScopeResolutionStrategyInfo(List<PreferenceScope>, PreferenceScope) - Constructor for class org.uberfire.preferences.shared.impl.PreferenceScopeResolutionStrategyInfo
 
PreferenceScopeResolver - Interface in org.uberfire.preferences.shared
Provides a way to obtain scopes related to a scope resolution order.
PreferenceScopeTypes - Interface in org.uberfire.preferences.shared
Defines which scopes are supported by the preference API.
PreferenceScopeTypesProducer - Class in org.uberfire.preferences.shared.impl
 
PreferenceScopeTypesProducer() - Constructor for class org.uberfire.preferences.shared.impl.PreferenceScopeTypesProducer
 
preferenceScopeTypesProducer() - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeTypesProducer
 
PreferenceScopeValidator - Interface in org.uberfire.preferences.shared
Provides a simple validator method for preference scopes.
PreferenceScopeValidatorImpl - Class in org.uberfire.preferences.shared.impl
 
PreferenceScopeValidatorImpl() - Constructor for class org.uberfire.preferences.shared.impl.PreferenceScopeValidatorImpl
 
PreferenceScopeValidatorImpl(PreferenceScopeTypes, PreferenceScopeResolutionStrategy) - Constructor for class org.uberfire.preferences.shared.impl.PreferenceScopeValidatorImpl
 
PreferenceStorage - Interface in org.uberfire.preferences.shared
Storage API for preferences.
PreferenceStore - Interface in org.uberfire.preferences.shared
Store API for preferences.
Property - Annotation Type in org.uberfire.preferences.shared.annotations
Annotation used to mark preference beans properties.
PropertyFormOptions - Enum in org.uberfire.preferences.shared
 
PropertyFormType - Enum in org.uberfire.preferences.shared
Enum used to define a property type for default form generation purposes.
PropertyValidator<T> - Interface in org.uberfire.preferences.shared
 
put(PreferenceScope, String, T) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Stores a preference inside a specific scope.
put(PreferenceScopeResolutionStrategyInfo, String, T) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Stores a preference inside the default scope (see defaultScope.
put(String, T) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Stores a preference inside the default scope (see defaultScope.
put(PreferenceScope, Map<String, T>) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Stores several preferences inside a specific scope.
put(PreferenceScopeResolutionStrategyInfo, Map<String, T>) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Stores several preferences inside the default scope (see defaultScope.
put(Map<String, T>) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Stores several preferences inside the default scope (see defaultScope.
putIfAbsent(PreferenceScope, String, T) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Stores a preference inside a specific scope, if it is not already defined in that scope.
putIfAbsent(PreferenceScopeResolutionStrategyInfo, String, T) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Stores a preference inside the default scope (see defaultScope, if it is not already defined in that scope.
putIfAbsent(String, T) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Stores a preference inside the default scope (see defaultScope, if it is not already defined in that scope.
putIfAbsent(PreferenceScope, Map<String, T>) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Stores several preferences inside a specific scope, if they are not already defined in that scope.
putIfAbsent(PreferenceScopeResolutionStrategyInfo, Map<String, T>) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Stores several preferences inside the default scope (see defaultScope, if they are not already defined in that scope.
putIfAbsent(Map<String, T>) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Stores several preferences inside the default scope (see defaultScope.

R

read(PreferenceScope, String) - Method in interface org.uberfire.preferences.shared.PreferenceStorage
Tries to read a preference value from a specific scope.
read(PreferenceScopeResolutionStrategyInfo, String) - Method in interface org.uberfire.preferences.shared.PreferenceStorage
Tries to read a preference value from a scope hierarchy.
readWithScope(PreferenceScopeResolutionStrategyInfo, String) - Method in interface org.uberfire.preferences.shared.PreferenceStorage
Tries to read a preference value from a scope hierarchy.
remove(PreferenceScope, String) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Removes a preference from a specific scope.
remove(List<PreferenceScope>, String) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Removes a preference from a list of scopes.
resolve(String...) - Method in class org.uberfire.preferences.shared.impl.DefaultPreferenceScopeResolver
 
resolve(String...) - Method in interface org.uberfire.preferences.shared.PreferenceScopeResolver
Returns a PreferenceScope that belongs to the resolution strategy hierarchy, based on the passed types.
RootPreference - Annotation Type in org.uberfire.preferences.shared.annotations
Annotation used to qualify generated portable implementations of root preference beans.

S

save() - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Saves the preference content recursively through its properties.
save(ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Saves the preference content recursively through its properties.
save(Command, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Saves the preference content recursively through its properties.
save(PreferenceScopeResolutionStrategyInfo) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Saves the preference content recursively through its properties.
save(PreferenceScopeResolutionStrategyInfo, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Saves the preference content recursively through its properties.
save(PreferenceScopeResolutionStrategyInfo, Command, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Saves the preference content recursively through its properties.
save(PreferenceScope) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Saves the preference content recursively through its properties.
save(PreferenceScope, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Saves the preference content recursively through its properties.
save(PreferenceScope, Command, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.BasePreference
Saves the preference content recursively through its properties.
save() - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockBeanGeneratedImpl
 
save(ParameterizedCommand<Throwable>) - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockBeanGeneratedImpl
 
save(Command, ParameterizedCommand<Throwable>) - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockBeanGeneratedImpl
 
save(PreferenceScopeResolutionStrategyInfo) - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockBeanGeneratedImpl
 
save(PreferenceScopeResolutionStrategyInfo, ParameterizedCommand<Throwable>) - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockBeanGeneratedImpl
 
save(PreferenceScopeResolutionStrategyInfo, Command, ParameterizedCommand<Throwable>) - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockBeanGeneratedImpl
 
save(T) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanServerStore
Saves all preference data.
save(T, PreferenceScopeResolutionStrategyInfo) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanServerStore
Saves all preference data, following the passed scope resolution strategy.
save(T, PreferenceScope) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanServerStore
Saves all preference data, inside the passed scope.
save(Collection<BasePreferencePortable<? extends BasePreference<?>>>) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanServerStore
Saves all preferences passed.
save(Collection<BasePreferencePortable<? extends BasePreference<?>>>, PreferenceScopeResolutionStrategyInfo) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanServerStore
Saves all preferences passed, following the passed scope resolution strategy.
save(Collection<BasePreferencePortable<? extends BasePreference<?>>>, PreferenceScope) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanServerStore
Saves all preferences passed, following the passed scope resolution strategy.
save(T, Command, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanStore
Saves all preference data.
save(T, PreferenceScopeResolutionStrategyInfo, Command, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanStore
Saves all preference data, following the passed scope resolution strategy.
save(T, PreferenceScope, Command, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanStore
Saves all preference data, following the passed scope resolution strategy.
save(Collection<BasePreferencePortable<? extends BasePreference<?>>>, Command, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanStore
Saves all preferences passed.
save(Collection<BasePreferencePortable<? extends BasePreference<?>>>, PreferenceScopeResolutionStrategyInfo, Command, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanStore
Saves all preferences passed, following the passed scope resolution strategy.
save(Collection<BasePreferencePortable<? extends BasePreference<?>>>, PreferenceScope, Command, ParameterizedCommand<Throwable>) - Method in interface org.uberfire.preferences.shared.bean.PreferenceBeanStore
Saves all preferences passed, following the passed scope resolution strategy.
search(PreferenceScope, Collection<String>) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves several preferences, which keys were passed, from a specific scope.
search(PreferenceScopeResolutionStrategyInfo, Collection<String>) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves several preferences, which keys were passed.
search(Collection<String>) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves several preferences, which keys were passed.
searchScoped(PreferenceScopeResolutionStrategyInfo, Collection<String>) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves several scoped preferences, which keys were passed.
searchScoped(Collection<String>) - Method in interface org.uberfire.preferences.shared.PreferenceStore
Retrieves several scoped preferences, which keys were passed.
set(String, Object) - Method in interface org.uberfire.preferences.shared.bean.BasePreferencePortable
Sets a property value by its name.
set(String, Object) - Method in class org.uberfire.preferences.shared.bean.mock.PortablePreferenceMockPortableGeneratedImpl
 
setBundleKey(String) - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
setChildren(List<PreferenceHierarchyElement<?>>) - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
setId(String) - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
setPortablePreference(BasePreferencePortable<T>) - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
setRoot(boolean) - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
setShared(boolean) - Method in class org.uberfire.preferences.shared.bean.PreferenceHierarchyElement
 
StringPropertyValidator - Class in org.uberfire.preferences.shared.impl.validation
 
StringPropertyValidator(Predicate<String>, String) - Constructor for class org.uberfire.preferences.shared.impl.validation.StringPropertyValidator
 

T

toString(Object) - Method in enum org.uberfire.preferences.shared.PropertyFormType
 
type() - Method in enum org.uberfire.preferences.shared.impl.DefaultScopes
 
type() - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeImpl
 
type() - Method in interface org.uberfire.preferences.shared.PreferenceScope
 
typeRequiresKey(String) - Method in class org.uberfire.preferences.shared.impl.DefaultPreferenceScopeTypes
 
typeRequiresKey(String) - Method in interface org.uberfire.preferences.shared.PreferenceScopeTypes
Checks if a scope type requires a custom key.

U

UsernameProvider - Interface in org.uberfire.preferences.shared
 

V

validate(PreferenceScope) - Method in class org.uberfire.preferences.shared.impl.PreferenceScopeValidatorImpl
 
validate(Object) - Method in class org.uberfire.preferences.shared.impl.validation.ConstrainedValuesValidator
 
validate(Object) - Method in class org.uberfire.preferences.shared.impl.validation.EnumValuePropertyValidator
 
validate(String) - Method in class org.uberfire.preferences.shared.impl.validation.StringPropertyValidator
 
validate(PreferenceScope) - Method in interface org.uberfire.preferences.shared.PreferenceScopeValidator
Checks if a scope is valid.
validate(T) - Method in interface org.uberfire.preferences.shared.PropertyValidator
 
validateType(String) - Method in class org.uberfire.preferences.shared.impl.DefaultPreferenceScopeTypes
 
ValidationResult - Class in org.uberfire.preferences.shared.impl.validation
 
ValidationResult() - Constructor for class org.uberfire.preferences.shared.impl.validation.ValidationResult
 
ValidationResult(boolean, List<String>) - Constructor for class org.uberfire.preferences.shared.impl.validation.ValidationResult
 
valueOf(String) - Static method in enum org.uberfire.preferences.shared.impl.DefaultScopes
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.uberfire.preferences.shared.PropertyFormOptions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.uberfire.preferences.shared.PropertyFormType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.uberfire.preferences.shared.impl.DefaultScopes
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.uberfire.preferences.shared.PropertyFormOptions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.uberfire.preferences.shared.PropertyFormType
Returns an array containing the constants of this enum type, in the order they are declared.

W

WorkbenchPreference - Annotation Type in org.uberfire.preferences.shared.annotations
Annotation used to qualify preference beans.
write(PreferenceScope, String, Object) - Method in interface org.uberfire.preferences.shared.PreferenceStorage
(Over) Writes a preference value related to a preference key, for a specific scope.
A B C D E F G H I K L N O P R S T U V W 
Skip navigation links
Uberfire Preferences API 2.11.0.Final-redhat-00002

Copyright © 2012–2018 JBoss by Red Hat. All rights reserved.