org.nuxeo.ecm.localconf

Interface SimpleConfiguration

All Superinterfaces:

DetachedAdapter, LocalConfiguration<SimpleConfiguration>

All Known Implementing Classes:

SimpleConfigurationAdapter, SimpleUserPreferences

public interface SimpleConfiguration
extends LocalConfiguration<SimpleConfiguration>

An object that maps keys to values.

The mappings can be stored on documents with the facet SimpleConfiguration.

Since:

5.5

Author:

Thomas Roger

Field Summary

Fields

Modifier and Type	Field and Description
static String	SIMPLE_CONFIGURATION_FACET
static String	SIMPLE_CONFIGURATION_PARAMETER_KEY
static String	SIMPLE_CONFIGURATION_PARAMETER_VALUE
static String	SIMPLE_CONFIGURATION_PARAMETERS_PROPERTY
static String	SIMPLE_CONFIGURATION_SCHEMA

Method Summary

Modifier and Type	Method and Description
String	get(String key) Returns the value to which the specified key is mapped, or null if there is no mapping for the key.
String	get(String key, String defaultValue) Returns the value to which the specified key is mapped, or the given default value if there is no mapping for the key.
String	put(String key, String value) Associates the specified value with the specified key.
void	putAll(Map<String,String> parameters) Copies all of the parameters from the specified map to this Simple configuration

Methods inherited from interface org.nuxeo.ecm.core.api.localconfiguration.LocalConfiguration

canMerge, getDocumentRef, merge, save

Field Detail

SIMPLE_CONFIGURATION_FACET

static final String SIMPLE_CONFIGURATION_FACET

See Also:

Constant Field Values

SIMPLE_CONFIGURATION_SCHEMA

static final String SIMPLE_CONFIGURATION_SCHEMA

See Also:

Constant Field Values

SIMPLE_CONFIGURATION_PARAMETERS_PROPERTY

static final String SIMPLE_CONFIGURATION_PARAMETERS_PROPERTY

See Also:

Constant Field Values

SIMPLE_CONFIGURATION_PARAMETER_KEY

static final String SIMPLE_CONFIGURATION_PARAMETER_KEY

See Also:

Constant Field Values

SIMPLE_CONFIGURATION_PARAMETER_VALUE

static final String SIMPLE_CONFIGURATION_PARAMETER_VALUE

See Also:

Constant Field Values

Method Detail

get

String get(String key)

Returns the value to which the specified key is mapped, or null if there is no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

get

String get(String key,
           String defaultValue)

Returns the value to which the specified key is mapped, or the given default value if there is no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the value returned if there is no mapping for the key

put

String put(String key,
           String value)

Associates the specified value with the specified key.

If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

the previous value associated with key, or null if there was no mapping for key.

putAll

void putAll(Map<String,String> parameters)

Copies all of the parameters from the specified map to this Simple configuration

Parameters:

parameters - parameters to be stored in this Simple configuration