Package org.nuxeo.ecm.localconf
Class SimpleConfigurationAdapter
java.lang.Object
org.nuxeo.ecm.core.api.localconfiguration.AbstractLocalConfiguration<SimpleConfiguration>
org.nuxeo.ecm.localconf.SimpleConfigurationAdapter
- All Implemented Interfaces:
DetachedAdapter
,LocalConfiguration<SimpleConfiguration>
,SimpleConfiguration
- Direct Known Subclasses:
SimpleUserPreferences
public class SimpleConfigurationAdapter
extends AbstractLocalConfiguration<SimpleConfiguration>
implements SimpleConfiguration
Default implementation of
SimpleConfiguration
.- Since:
- 5.5
- Author:
- Thomas Roger
- See Also:
-
Field Summary
Fields inherited from interface org.nuxeo.ecm.localconf.SimpleConfiguration
SIMPLE_CONFIGURATION_FACET, SIMPLE_CONFIGURATION_PARAMETER_KEY, SIMPLE_CONFIGURATION_PARAMETER_VALUE, SIMPLE_CONFIGURATION_PARAMETERS_PROPERTY, SIMPLE_CONFIGURATION_SCHEMA
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
canMerge()
Returnstrue
if thisLocalConfiguration
accepted to be merged with a parent configuration,false
otherwise.computeParametersForDocument
(Map<String, String> parameters) Returns 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.Returns the relatedDocumentRef
of this local configuration.protected void
merge
(SimpleConfiguration other) Merge thisLocalConfiguration
with another one.Associates the specified value with the specified key.void
Copies all of the parameters from the specified map to this Simple configurationvoid
save
(CoreSession session) Save this LocalConfiguration.
-
Field Details
-
detachedDocument
-
parameters
-
-
Constructor Details
-
SimpleConfigurationAdapter
-
-
Method Details
-
loadFromDocument
-
computeParametersFromDocument
-
get
Description copied from interface:SimpleConfiguration
Returns the value to which the specifiedkey
is mapped, ornull
if there is no mapping for thekey
.- Specified by:
get
in interfaceSimpleConfiguration
- Parameters:
key
- the key whose associated value is to be returned
-
get
Description copied from interface:SimpleConfiguration
Returns the value to which the specified key is mapped, or the given default value if there is no mapping for the key.- Specified by:
get
in interfaceSimpleConfiguration
- Parameters:
key
- the key whose associated value is to be returneddefaultValue
- the value returned if there is no mapping for the key
-
put
Description copied from interface:SimpleConfiguration
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.
- Specified by:
put
in interfaceSimpleConfiguration
- 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
Description copied from interface:SimpleConfiguration
Copies all of the parameters from the specified map to this Simple configuration- Specified by:
putAll
in interfaceSimpleConfiguration
- Parameters:
parameters
- parameters to be stored in this Simple configuration
-
getDocumentRef
Description copied from interface:LocalConfiguration
Returns the relatedDocumentRef
of this local configuration.- Specified by:
getDocumentRef
in interfaceLocalConfiguration<SimpleConfiguration>
-
canMerge
public boolean canMerge()Description copied from interface:LocalConfiguration
Returnstrue
if thisLocalConfiguration
accepted to be merged with a parent configuration,false
otherwise.- Specified by:
canMerge
in interfaceLocalConfiguration<SimpleConfiguration>
- Overrides:
canMerge
in classAbstractLocalConfiguration<SimpleConfiguration>
-
merge
Description copied from interface:LocalConfiguration
Merge thisLocalConfiguration
with another one.- Specified by:
merge
in interfaceLocalConfiguration<SimpleConfiguration>
- Overrides:
merge
in classAbstractLocalConfiguration<SimpleConfiguration>
-
save
Description copied from interface:LocalConfiguration
Save this LocalConfiguration.- Specified by:
save
in interfaceLocalConfiguration<SimpleConfiguration>
- Overrides:
save
in classAbstractLocalConfiguration<SimpleConfiguration>
-
computeParametersForDocument
-