org.ops4j.pax.exam.cm

Interface ConfigurationOption

All Known Implementing Classes:

ConfigurationProvisionOption

public interface ConfigurationOption

The ConfigurationOption allows to specify a Map of properties that are injected into the container. You have the choice of either create (the default) or override an existing configuration Configuration Options e.g. in ConfigAdmin

Method Summary

Modifier and Type	Method and Description
org.ops4j.pax.exam.Option	asOption() Creates an Option from the current settings that could be used in Configure methods
ConfigurationOption	create(boolean create) Specify if the configuration should be created if it does not yet exits
ConfigurationOption	factory(boolean factory) Specify if the target of the properties are a factory configuration
String	getId()
Map<String,?>	getProperties()
boolean	isCreate()
boolean	isFactory()
boolean	isOverride()
ConfigurationOption	override(boolean override) Specify if the properties of an existing configuration should be overriden/extended by the ones given here, this does not work with factories!
ConfigurationOption	put(String key, Object value) Add the key/value pair to the overriden options.
ConfigurationOption	putAll(Map<String,?> properties) Puts all properties from the given map to this configuration object, see put(String, Object) for more details

Method Detail

getId

String getId()

Returns:

the current value of id

put

ConfigurationOption put(String key,
                        Object value)

Add the key/value pair to the overriden options. Only the following "primary property types" are supported by the ConfigurationAdmin

• primitive types
• object variants of primitive types (like Integer, Boolean, and so on)
• arrays or collections (must be serializable!) of all types

Also make sure not to contain case variants, because they are also not allowed and keep in mind that some properties can't be overriden

Parameters:

key - property key

value - property value

Returns:

this for chaining

putAll

ConfigurationOption putAll(Map<String,?> properties)

Puts all properties from the given map to this configuration object, see put(String, Object) for more details

Parameters:

properties - configuration properties

Returns:

this for chaining

getProperties

Map<String,?> getProperties()

Returns:

the current value of overrideValues

create

ConfigurationOption create(boolean create)

Specify if the configuration should be created if it does not yet exits

Parameters:

create - should configuration be created?

Returns:

this for chaining

override

ConfigurationOption override(boolean override)

Specify if the properties of an existing configuration should be overriden/extended by the ones given here, this does not work with factories!

Parameters:

override - should this option override an existing one?

Returns:

this for chaining

factory

ConfigurationOption factory(boolean factory)

Specify if the target of the properties are a factory configuration

Parameters:

factory - is this a factory configuration?

Returns:

this for chaining

isCreate

boolean isCreate()

Returns:

true if this configuration should be created if not exits, false otherwhise

isOverride

boolean isOverride()

Returns:

true if existing configurations should be extended/ovewritten false otherwhise

isFactory

boolean isFactory()

Returns:

true if a factory configuration should be created false otherwhise

asOption

org.ops4j.pax.exam.Option asOption()

Creates an Option from the current settings that could be used in Configure methods

Returns:

this configuration as an Option