org.eclipse.ocl.examples.pivot.options
Class ParsingOptions

java.lang.Object
  org.eclipse.ocl.examples.pivot.options.ParsingOptions

public class ParsingOptions
extends java.lang.Object

Options applicable to Environments to customize their parsing behaviour.

Author:

Christian W. Damus (cdamus)

Field Summary

static Option<java.lang.Boolean>	DEFINITION_CONSTRAINS_FEATURE Parsing option indicating whether to reference the defined property or operation in a def: expression as a constrained element of the constraint, in addition to the context classifier.
static Option<?>	IMPLICIT_ROOT_CLASS Static instance for the implicit-root-class option token.
static Option<java.lang.Boolean>	SUPPORT_STATIC_FEATURES Parsing option indicating whether to accept static as part of a definition constraint.
static Option<java.lang.Boolean>	USE_BACKSLASH_ESCAPE_PROCESSING Parsing option indicating whether to process backslash escape sequences ( \n, \r, etc.) as specified by OMG Issue 14357 for OCL 2.3.
static Option<java.lang.Boolean>	USE_COMPARE_TO_OPERATION Parsing option indicating whether to interpolate <, <=, >, and >= operations when a model type defines a Java-style compareTo(...) operation.
static Option<java.lang.Boolean>	WARN_OF_XOR_OR_AND_PRECEDENCE_CHANGE Parsing option indicating whether to generate a warning when the OCL 2.1 parsing of distinct xor, or, and precedences leads to a different parse to the OCL 2.0 specification of all levels equal.

Method Summary

static <T> T	getValue(Environment env, Option<T> option) Obtains the value of the specified option's setting in the the given environment's options map, adapting the environment as necessary to the Customizable API.
static Option<Type>	implicitRootClass(Environment env) A parsing option specifying a class that's assumed to be the implicit root of the subject model's class hierarchy.
static <T> void	setOption(Environment env, Option<T> option, T value) Add an option to apply to the specified environment, adapting it as necessary to the Customizable API.

Methods inherited from class java.lang.Object

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

Field Detail

DEFINITION_CONSTRAINS_FEATURE

@NonNull
public static final Option<java.lang.Boolean> DEFINITION_CONSTRAINS_FEATURE

Parsing option indicating whether to reference the defined property or operation in a def: expression as a constrained element of the constraint, in addition to the context classifier. The well-formedness rules for definition constraints in the OCL 2.0 Specification require that a definition constraint reference only its context classifier as a constrained element.

The default value of this option is false. For compatibility with the 1.1 release behaviour, set this option true. Note that this is not necessary for loading and processing constraints created by the 1.1 release, only for persisting constraints that will be consumed by the 1.1 release.

USE_COMPARE_TO_OPERATION

@NonNull
public static final Option<java.lang.Boolean> USE_COMPARE_TO_OPERATION

Parsing option indicating whether to interpolate <, <=, >, and >= operations when a model type defines a Java-style compareTo(...) operation.

The default value of this option is false. For compatibility with the 1.1 release behaviour, set this option true.

WARN_OF_XOR_OR_AND_PRECEDENCE_CHANGE

@NonNull
public static final Option<java.lang.Boolean> WARN_OF_XOR_OR_AND_PRECEDENCE_CHANGE

Parsing option indicating whether to generate a warning when the OCL 2.1 parsing of distinct xor, or, and precedences leads to a different parse to the OCL 2.0 specification of all levels equal. The default value of this option is false. To diagnose compatibility with the OCL 2.0 behaviour in the MDT-OCL 1.x release, set this option true.

IMPLICIT_ROOT_CLASS

@NonNull
public static final Option<?> IMPLICIT_ROOT_CLASS

Static instance for the implicit-root-class option token. It is returned via an unchecked cast by the #implicitRootClass() method.

USE_BACKSLASH_ESCAPE_PROCESSING

@NonNull
public static final Option<java.lang.Boolean> USE_BACKSLASH_ESCAPE_PROCESSING

Parsing option indicating whether to process backslash escape sequences ( \n, \r, etc.) as specified by OMG Issue 14357 for OCL 2.3.

The default value of this option is true. To disable backslash escaping support, set this option false.

SUPPORT_STATIC_FEATURES

@NonNull
public static final Option<java.lang.Boolean> SUPPORT_STATIC_FEATURES

Parsing option indicating whether to accept static as part of a definition constraint. static are a proposed cpability of OCL 2.1, however they are only available for meta-models that implement the UMLReflection#setIsStatic(Object, boolean) method. Therefore use of static constraints will generate an error message on the Ecore binding regardless of this setting.

The default value of this option is true. For stricter compatibility with OCL 2.0, set this option false.

See Also:

UMLReflection#setIsStatic(Object, boolean)

Method Detail

implicitRootClass

@NonNull
public static Option<Type> implicitRootClass(@NonNull
                                                     Environment env)

A parsing option specifying a class that's assumed to be the implicit root of the subject model's class hierarchy. Note that this excludes datatypes defined by OCL such as the collections and tuples, and also those defined by the subject model. This option is only used in accessing operations and attributes; for other characteristics of a classifier, a specialized environment implementation is required.

This option is commonly used to provide access to operations and attributes defined by an implicit root extends class in Ecore-based models, for example, such as EObject, that is not explicitly referenced in the subject model.

The default value of this option is null.

Type Parameters:

C - the type representing classes in the target metamodel, consistent with the current Environment implementation

Parameters:

env - the environment to which this option is to be applied

Returns:

the option token

setOption

public static <T> void setOption(@NonNull
                                 Environment env,
                                 @NonNull
                                 Option<T> option,
                                 @Nullable
                                 T value)

Add an option to apply to the specified environment, adapting it as necessary to the Customizable API.

Parameters:

env - an environment on which to set an option

option - the option

value - the option's value

See Also:

Cusotmizable#setOption(Option, Object)

getValue

@Nullable
public static <T> T getValue(@NonNull
                                      Environment env,
                                      @NonNull
                                      Option<T> option)

Obtains the value of the specified option's setting in the the given environment's options map, adapting the environment as necessary to the Customizable API. If not already set, return the option's default value.

Parameters:

env - an environment on which to query an option

option - an option to query

Returns:

value of the option

See Also:

Customizable.getValue(Option)