org.ops4j.pax.exam.cm

Class ConfigurationProvisionOption

java.lang.Object

org.ops4j.pax.exam.cm.ConfigurationProvisionOption

All Implemented Interfaces:

ConfigurationOption

public class ConfigurationProvisionOption
extends Object
implements ConfigurationOption

Implementation of the ConfigurationOption interface used internally when construction such options

Constructor Summary

Constructors

Constructor and Description
ConfigurationProvisionOption(String id, Map<String,Object> properties) Creates a new ConfigurationOption for the given id and the given property values

Method Summary

Modifier and Type	Method and Description
org.ops4j.pax.exam.options.ProvisionOption<?>	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 ConfigurationOption.put(String, Object) for more details

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationProvisionOption

public ConfigurationProvisionOption(String id,
                                    Map<String,Object> properties)

Creates a new ConfigurationOption for the given id and the given property values

Parameters:

id - configuration PID

properties - configuration properties

Method Detail

getId

public String getId()

Specified by:

getId in interface ConfigurationOption

Returns:

the current value of id

put

public ConfigurationOption put(String key,
                               Object value)

Add the key/value pair to the overriden options

Specified by:

put in interface ConfigurationOption

Parameters:

key - property key

value - property value

Returns:

this for chaining

putAll

public ConfigurationOption putAll(Map<String,?> _properties)

Description copied from interface: ConfigurationOption

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

Specified by:

putAll in interface ConfigurationOption

Parameters:

_properties - configuration properties

Returns:

this for chaining

getProperties

public Map<String,?> getProperties()

Specified by:

getProperties in interface ConfigurationOption

Returns:

the current value of overrideValues

create

public ConfigurationOption create(boolean _create)

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

Specified by:

create in interface ConfigurationOption

Parameters:

_create - should this option be created?

Returns:

this for chaining

override

public 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!

Specified by:

override in interface ConfigurationOption

Parameters:

_override - should existing properties be overridden

Returns:

this for chaining

factory

public ConfigurationOption factory(boolean _factory)

Specify if the target of the properties are a factory configuration

Specified by:

factory in interface ConfigurationOption

Parameters:

_factory - is this a factory configuration?

Returns:

this for chaining

isCreate

public boolean isCreate()

Specified by:

isCreate in interface ConfigurationOption

Returns:

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

isOverride

public boolean isOverride()

Specified by:

isOverride in interface ConfigurationOption

Returns:

true if existing configurations should be extended/ovewritten false otherwhise

isFactory

public boolean isFactory()

Specified by:

isFactory in interface ConfigurationOption

Returns:

true if a factory configuration should be created false otherwhise

asOption

public org.ops4j.pax.exam.options.ProvisionOption<?> asOption()

Description copied from interface: ConfigurationOption

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

Specified by:

asOption in interface ConfigurationOption

Returns:

this configuration as an Option