Package org.uberfire.preferences.shared.impl

Class PreferenceScopeFactoryImpl

java.lang.Object

org.uberfire.preferences.shared.impl.PreferenceScopeFactoryImpl

All Implemented Interfaces:

PreferenceScopeFactory

@ApplicationScoped
public class PreferenceScopeFactoryImpl
extends Object
implements PreferenceScopeFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PreferenceScopeFactoryImpl()
	PreferenceScopeFactoryImpl(PreferenceScopeTypes scopeTypes)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PreferenceScopeFactoryImpl

protected PreferenceScopeFactoryImpl()

PreferenceScopeFactoryImpl

@Inject
public PreferenceScopeFactoryImpl(PreferenceScopeTypes scopeTypes)

Method Detail

createScope

public PreferenceScope createScope(String type)
                            throws InvalidPreferenceScopeException

Description copied from interface: PreferenceScopeFactory

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

Specified by:

createScope in interface PreferenceScopeFactory

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

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

Description copied from interface: PreferenceScopeFactory

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

Specified by:

createScope in interface PreferenceScopeFactory

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

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

Description copied from interface: PreferenceScopeFactory

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

Specified by:

createScope in interface PreferenceScopeFactory

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

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

Description copied from interface: PreferenceScopeFactory

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

Specified by:

createScope in interface PreferenceScopeFactory

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

public PreferenceScope createScope(PreferenceScope... scopes)
                            throws InvalidPreferenceScopeException

Description copied from interface: PreferenceScopeFactory

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

Specified by:

createScope in interface PreferenceScopeFactory

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

public PreferenceScope cloneScope(PreferenceScope scope)

Description copied from interface: PreferenceScopeFactory

Clones the passed scope to a new instance.

Specified by:

cloneScope in interface PreferenceScopeFactory

Parameters:

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

Returns:

New scope instance equal to the passed one.