org.eclipse.ocl.options
Interface Customizable

All Known Subinterfaces:

BasicEnvironment, BasicEnvironment2, Environment.Internal<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

All Known Implementing Classes:

AbstractBasicEnvironment, AbstractEnvironment, AbstractEvaluationEnvironment, EcoreEnvironment, EcoreEvaluationEnvironment, EcoreEvaluationEnvironmentWithScopedExtentMap, PartialEcoreEvaluationEnvironment, UMLEnvironment, UMLEvaluationEnvironment

public interface Customizable

An optional adapter interface for entities whose behaviour can be customized by clients by the application of Options. The primary customizable entities are parsing Environments and EvaluationEnvironments.

Since:

1.2

Author:

Christian W. Damus (cdamus)

Method Summary

java.util.Map<Option<?>,java.lang.Object>	clearOptions() Clears all options.
java.util.Map<Option<?>,java.lang.Object>	getOptions() Obtains a copy of my map of options.
<T> T	getValue(Option<T> option) Obtains the value of the specified option's setting in the my options map.
boolean	isEnabled(Option<java.lang.Boolean> option) Queries whether the specified boolean-valued option is enabled.
<T> void	putOptions(java.util.Map<? extends Option<T>,? extends T> options) Adds options to apply to my behaviour.
<T> T	removeOption(Option<T> option) Removes the specified option.
<T> java.util.Map<Option<T>,T>	removeOptions(java.util.Collection<Option<T>> options) Removes the specified options.
<T> void	setOption(Option<T> option, T value) Add an option to apply to my behaviour.

Method Detail

getOptions

java.util.Map<Option<?>,java.lang.Object> getOptions()

Obtains a copy of my map of options. Options not explicitly set in an environment are inherited from the parent environment, if any, otherwise they are at their default values.

Returns:

the map of options

getValue

<T> T getValue(Option<T> option)

Obtains the value of the specified option's setting in the my options map. Options not explicitly set in an environment are inherited from the parent environment, if any, otherwise they are at their default values.

Parameters:

option - the option to query

Returns:

value of the option

isEnabled

boolean isEnabled(Option<java.lang.Boolean> option)

Queries whether the specified boolean-valued option is enabled. This method essentially just puts a nice "is" name on boolean options. Options not explicitly set in an environment are inherited from the parent environment, if any, otherwise they are at their default values.

Parameters:

option - an option

Returns:

whether the option is enabled

setOption

<T> void setOption(Option<T> option,
                   T value)

Add an option to apply to my behaviour.

Parameters:

option - the option

value - the option's value

putOptions

<T> void putOptions(java.util.Map<? extends Option<T>,? extends T> options)

Adds options to apply to my behaviour.

Parameters:

options - the options

removeOption

<T> T removeOption(Option<T> option)

Removes the specified option.

Parameters:

option - the option to remove

Returns:

the former value of the option

removeOptions

<T> java.util.Map<Option<T>,T> removeOptions(java.util.Collection<Option<T>> options)

Removes the specified options.

Parameters:

options - the options to remove

Returns:

the former values of the options

clearOptions

java.util.Map<Option<?>,java.lang.Object> clearOptions()

Clears all options.

Returns:

the former values of the options