eu.cqse.check.framework.core.phase

Enum ECodeViewOption

java.lang.Object

java.lang.Enum<ECodeViewOption>

eu.cqse.check.framework.core.phase.ECodeViewOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ECodeViewOption>

public enum ECodeViewOption
extends java.lang.Enum<ECodeViewOption>

Enum specifying which code representation should be retrieved or which code representation is used as base for finding generation. For example, the offsets used when specifying finding locations depend on whether the code is filtered or not.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ECodeViewOption.ETextViewOption Options for processing which is done on the file content (plain text) before scanning.
static class	ECodeViewOption.ETokenViewOption Options for processing which is done on the token stream after scanning and before parsing.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FILTERED filtered text, not preprocessed.
FILTERED_PREPROCESSED filtered text, preprocessed (global define/macro resolution).
UNFILTERED unfiltered text, not preprocessed.
UNFILTERED_PREPROCESSED unfiltered text, preprocessed (only file-local define/macro resolution)

Field Summary

Fields

Modifier and Type	Field and Description
ECodeViewOption.ETextViewOption	textView Processing which is executed on the file content (plain text) before scanning (token generation).
ECodeViewOption.ETokenViewOption	tokenView Processing which is executed on the token stream after scanning and before parsing.

Method Summary

Modifier and Type	Method and Description
static ECodeViewOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ECodeViewOption[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNFILTERED

public static final ECodeViewOption UNFILTERED

unfiltered text, not preprocessed. When using this to retrieve ShallowEntities, the resulting ShallowEntities are based on preprocessed tokens, but the tokens generated by the preprocessor are removed after parsing.

UNFILTERED_PREPROCESSED

public static final ECodeViewOption UNFILTERED_PREPROCESSED

unfiltered text, preprocessed (only file-local define/macro resolution)

FILTERED

public static final ECodeViewOption FILTERED

filtered text, not preprocessed. When using this to retrieve ShallowEntities, the resulting ShallowEntities are based on preprocessed tokens, but the tokens generated by the preprocessor are removed after parsing.

FILTERED_PREPROCESSED

public static final ECodeViewOption FILTERED_PREPROCESSED

filtered text, preprocessed (global define/macro resolution).

Field Detail

textView

public final ECodeViewOption.ETextViewOption textView

Processing which is executed on the file content (plain text) before scanning (token generation).

tokenView

public final ECodeViewOption.ETokenViewOption tokenView

Processing which is executed on the token stream after scanning and before parsing.

Method Detail

values

public static ECodeViewOption[] 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 (ECodeViewOption c : ECodeViewOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ECodeViewOption 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