Package org.uberfire.preferences.shared

Interface PreferenceScopeFactory

All Known Implementing Classes:

PreferenceScopeFactoryImpl

public interface PreferenceScopeFactory

Builder for new preference scope creation.

Method Summary

Modifier and Type	Method	Description
PreferenceScope	cloneScope(PreferenceScope scope)	Clones the passed scope to a new instance.
PreferenceScope	createScope(String type)	Builds a new preference scope, that does not require a custom key.
PreferenceScope	createScope(String type, String key)	Builds a new preference scope, that requires a custom key.
PreferenceScope	createScope(String type, String key, PreferenceScope childScope)	Builds a new preference scope, that requires a custom key, and has the passed child scope.
PreferenceScope	createScope(String type, PreferenceScope childScope)	Builds a new preference scope, that does not require a custom key, and has the passed child scope.
PreferenceScope	createScope(PreferenceScope... scopes)	Builds a new preference scope, that contains the following ones as child scopes.

Method Detail

createScope

PreferenceScope createScope(String type)
                     throws InvalidPreferenceScopeException

Builds a new preference scope, that does not require a custom key.

Parameters:

type - Type of the new preference scope.

Returns:

A new preference scope.

Throws:

InvalidPreferenceScopeException - if the type passed is invalid, or if it requires a key.

createScope

PreferenceScope createScope(String type,
                            PreferenceScope childScope)
                     throws InvalidPreferenceScopeException

Builds a new preference scope, that does not require a custom key, and has the passed child scope.

Parameters:

type - Type of the new preference scope.

Returns:

A new preference scope.

Throws:

InvalidPreferenceScopeException - if the type passed is invalid, or if it requires a key.

createScope

PreferenceScope createScope(String type,
                            String key)
                     throws InvalidPreferenceScopeException

Builds a new preference scope, that requires a custom key.

Parameters:

type - Type of the new preference scope.

key - Key of the new preference scope.

Returns:

A new preference scope.

Throws:

InvalidPreferenceScopeException - if the type passed is invalid, or if it does not require a key.

createScope

PreferenceScope createScope(String type,
                            String key,
                            PreferenceScope childScope)
                     throws InvalidPreferenceScopeException

Builds a new preference scope, that requires a custom key, and has the passed child scope.

Parameters:

type - Type of the new preference scope.

key - Key of the new preference scope.

childScope - Child scope of this scope. It can be null if the scope has no child.

Returns:

A new preference scope.

Throws:

InvalidPreferenceScopeException - if the type passed is invalid, or if it does not require a key.

createScope

PreferenceScope createScope(PreferenceScope... scopes)
                     throws InvalidPreferenceScopeException

Builds a new preference scope, that contains the following ones as child scopes.

Parameters:

scopes - The first scope is the root scope, the second is its child scope, and so on.

Returns:

A new preference scope.

Throws:

InvalidPreferenceScopeException - if any passed scope is invalid.

cloneScope

PreferenceScope cloneScope(PreferenceScope scope)

Clones the passed scope to a new instance.

Parameters:

scope - Scope to be cloned. Must not be null.

Returns:

New scope instance equal to the passed one.