org.uberfire.preferences.shared.impl

Class DefaultPreferenceScopeTypes

java.lang.Object

org.uberfire.preferences.shared.impl.DefaultPreferenceScopeTypes

All Implemented Interfaces:

PreferenceScopeTypes

@ApplicationScoped
public class DefaultPreferenceScopeTypes
extends Object
implements PreferenceScopeTypes

Default implementation for PreferenceScopeTypes. To override it, just provide a default CDI bean that implements PreferenceScopeTypes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	DefaultPreferenceScopeTypes.DefaultKey

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultPreferenceScopeTypes()
	DefaultPreferenceScopeTypes(UsernameProvider usernameProvider)

Method Summary

Modifier and Type	Method and Description
String	getDefaultKeyFor(String type) Returns the default key for a type.
protected boolean	isEmpty(String str)
boolean	typeRequiresKey(String type) Checks if a scope type requires a custom key.
protected void	validateType(String type)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPreferenceScopeTypes

protected DefaultPreferenceScopeTypes()

DefaultPreferenceScopeTypes

@Inject
public DefaultPreferenceScopeTypes(UsernameProvider usernameProvider)

Method Detail

typeRequiresKey

public boolean typeRequiresKey(String type)
                        throws InvalidPreferenceScopeException

Description copied from interface: PreferenceScopeTypes

Checks if a scope type requires a custom key.

Specified by:

typeRequiresKey in interface PreferenceScopeTypes

Parameters:

type - Type to check.

Returns:

true if the type requires a custom key or false if it has a default one.

Throws:

InvalidPreferenceScopeException - if the type passed is invalid.

getDefaultKeyFor

public String getDefaultKeyFor(String type)
                        throws InvalidPreferenceScopeException

Description copied from interface: PreferenceScopeTypes

Returns the default key for a type. Throws a exception if the type requires a custom one.

Specified by:

getDefaultKeyFor in interface PreferenceScopeTypes

Parameters:

type - Type to check.

Returns:

Default key for the type (or null if there is not one).

Throws:

InvalidPreferenceScopeException - if the type passed is invalid.

validateType

protected void validateType(String type)
                     throws InvalidPreferenceScopeException

Throws:

InvalidPreferenceScopeException

isEmpty

protected boolean isEmpty(String str)