Package org.nuxeo.ecm.localconf
Interface SimpleConfiguration
- All Superinterfaces:
DetachedAdapter
,LocalConfiguration<SimpleConfiguration>
- All Known Implementing Classes:
SimpleConfigurationAdapter
,SimpleUserPreferences
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
-
Method Summary
Modifier and TypeMethodDescriptionReturns the value to which the specifiedkey
is mapped, ornull
if there is no mapping for thekey
.Returns the value to which the specified key is mapped, or the given default value if there is no mapping for the key.Associates the specified value with the specified key.void
Copies all of the parameters from the specified map to this Simple configurationMethods inherited from interface org.nuxeo.ecm.core.api.localconfiguration.LocalConfiguration
canMerge, getDocumentRef, merge, save
-
Field Details
-
SIMPLE_CONFIGURATION_FACET
- See Also:
-
SIMPLE_CONFIGURATION_SCHEMA
- See Also:
-
SIMPLE_CONFIGURATION_PARAMETERS_PROPERTY
- See Also:
-
SIMPLE_CONFIGURATION_PARAMETER_KEY
- See Also:
-
SIMPLE_CONFIGURATION_PARAMETER_VALUE
- See Also:
-
-
Method Details
-
get
Returns the value to which the specifiedkey
is mapped, ornull
if there is no mapping for thekey
.- Parameters:
key
- the key whose associated value is to be returned
-
get
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 returneddefaultValue
- the value returned if there is no mapping for the key
-
put
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 associatedvalue
- value to be associated with the specified key- Returns:
- the previous value associated with
key
, ornull
if there was no mapping forkey
.
-
putAll
Copies all of the parameters from the specified map to this Simple configuration- Parameters:
parameters
- parameters to be stored in this Simple configuration
-