ProblemOption (MDT-OCL Documentation)

java.lang.Object
- java.lang.Enum<ProblemOption>
- - org.eclipse.ocl.options.ProblemOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProblemOption>, PreferenceableOption<ProblemHandler.Severity>, Option<ProblemHandler.Severity>
```
public enum ProblemOption
extends java.lang.Enum<ProblemOption>
implements PreferenceableOption<ProblemHandler.Severity>, Option<ProblemHandler.Severity>
```
Options for problem-reporting in parsing OCL constraints. These options determine the severity of usage of constructs that deviate from the OCL Specification.

Author:

Christian W. Damus (cdamus)

Nested Class Summary
- Nested classes/interfaces inherited from interface org.eclipse.ocl.common.preferences.PreferenceableOption
  PreferenceableOption.Listener, PreferenceableOption.PreferenceableOption2<T>

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AMBIGUOUS_ASSOCIATION_ENDS` Severity of the ambiguity when an unnavigable but named associend has the same name as the implicit name of an unnamed association end.
`CLOSURE_ITERATOR` Severity of using the non-spec `closure` iterator.
`CONCEPTUAL_OPERATION_NAME` Severity of making use of an operation name conceptually as in 7.4.8 .
`ELEMENT_NAME_QUOTE_ESCAPE` Severity of using the non-spec `"..."` escape sequence for element names consisting of multiple OCL tokens.
`INHERITED_FEATURE_CONTEXT` Severity of the problem to report when declaring (using the concrete syntax) an operation or property context in a classifier that inherits the feature (rather than declaring a redefinition of the feature as the context).
`STRING_CASE_CONVERSION` Severity of using the non-spec `toUpper()` and `toLower()` operations on `String`s.
`STRING_SINGLE_QUOTE_ESCAPE` Severity of using the non-spec `''` escape sequence for single-quotes in string literals.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProblemHandler.Severity`	`getDefaultValue()` Obtains the option's default value.
`java.lang.String`	`getKey()` Obtains my string key, which may be used for persistence in a preference store.
`java.lang.String`	`getPluginId()` Returns the plugin qualifier for the key.
`ProblemHandler.Severity`	`getValueOf(java.lang.String string)` Returns an option value from a String typically obtained from an Eclipse Preference file.
`java.lang.String`	`toString()`
`static ProblemOption`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static ProblemOption[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - CLOSURE_ITERATOR
```
public static final ProblemOption CLOSURE_ITERATOR
```
    Severity of using the non-spec closure iterator. The default severity is WARNING.
  - STRING_CASE_CONVERSION
```
public static final ProblemOption STRING_CASE_CONVERSION
```
    Severity of using the non-spec toUpper() and toLower() operations on Strings. The default severity is WARNING.
  - STRING_SINGLE_QUOTE_ESCAPE
```
public static final ProblemOption STRING_SINGLE_QUOTE_ESCAPE
```
    Severity of using the non-spec '' escape sequence for single-quotes in string literals. The default severity is WARNING.
  - ELEMENT_NAME_QUOTE_ESCAPE
```
public static final ProblemOption ELEMENT_NAME_QUOTE_ESCAPE
```
    Severity of using the non-spec "..." escape sequence for element names consisting of multiple OCL tokens. The default severity is WARNING.
  - AMBIGUOUS_ASSOCIATION_ENDS
```
public static final ProblemOption AMBIGUOUS_ASSOCIATION_ENDS
```
    Severity of the ambiguity when an unnavigable but named associend has the same name as the implicit name of an unnamed association end. The default severity is ERROR.
  - INHERITED_FEATURE_CONTEXT
```
public static final ProblemOption INHERITED_FEATURE_CONTEXT
```
    Severity of the problem to report when declaring (using the concrete syntax) an operation or property context in a classifier that inherits the feature (rather than declaring a redefinition of the feature as the context). This is allowed by the MDT OCL implementation but is not, strictly speaking, well-formed OCL. The default severity is WARNING.
  - CONCEPTUAL_OPERATION_NAME
```
public static final ProblemOption CONCEPTUAL_OPERATION_NAME
```
    Severity of making use of an operation name conceptually as in 7.4.8 . The default severity is OK.
    
    Since:
    
    3.0
- Method Detail
  - values
```
public static ProblemOption[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ProblemOption c : ProblemOption.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ProblemOption valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getKey
```
public java.lang.String getKey()
```
    Description copied from interface: PreferenceableOption
    
    Obtains my string key, which may be used for persistence in a preference store.
    
    Specified by:
    
    getKey in interface PreferenceableOption<ProblemHandler.Severity>
    
    Specified by:
    
    getKey in interface Option<ProblemHandler.Severity>
    
    Returns:
    
    my key. Is never null
  - getDefaultValue
```
public ProblemHandler.Severity getDefaultValue()
```
    Description copied from interface: PreferenceableOption
    
    Obtains the option's default value.
    
    Specified by:
    
    getDefaultValue in interface PreferenceableOption<ProblemHandler.Severity>
    
    Specified by:
    
    getDefaultValue in interface Option<ProblemHandler.Severity>
    
    Returns:
    
    my default value, which default-default is null
  - getPluginId
```
public java.lang.String getPluginId()
```
    Description copied from interface: PreferenceableOption
    
    Returns the plugin qualifier for the key.
    
    Specified by:
    
    getPluginId in interface PreferenceableOption<ProblemHandler.Severity>
    
    Since:
    
    3.2
  - getValueOf
```
public ProblemHandler.Severity getValueOf(java.lang.String string)
```
    Description copied from interface: PreferenceableOption
    
    Returns an option value from a String typically obtained from an Eclipse Preference file.
    
    Specified by:
    
    getValueOf in interface PreferenceableOption<ProblemHandler.Severity>
    
    Since:
    
    3.2
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<ProblemOption>

Enum ProblemOption

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ocl.common.preferences.PreferenceableOption

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CLOSURE_ITERATOR

STRING_CASE_CONVERSION

STRING_SINGLE_QUOTE_ESCAPE

ELEMENT_NAME_QUOTE_ESCAPE

AMBIGUOUS_ASSOCIATION_ENDS

INHERITED_FEATURE_CONTEXT

CONCEPTUAL_OPERATION_NAME

Method Detail

values

valueOf

getKey

getDefaultValue

getPluginId

getValueOf

toString