eu.cqse.check.framework.core

Enum ECheckParameter

java.lang.Object

java.lang.Enum<ECheckParameter>

eu.cqse.check.framework.core.ECheckParameter

All Implemented Interfaces:

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

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

An enumeration of all parameters that can be passed to a custom check or a custom check phase. Custom checks specify which parameters they need in their Check annotation. Custom check phases (IGlobalExtractionPhase) specify the required parameters in IGlobalExtractionPhase.getRequiredContextParameters().

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABSTRACT_SYNTAX_TREE Custom checks and custom check phases must require this parameter if they use tokens (ITokenElementContext.getTokens(ECodeViewOption)) or an abstract syntax tree (ITokenElementContext.getAbstractSyntaxTree(ECodeViewOption)) of the token element that is currently analyzed.
CLANG Parameter for using the Clang parser infrastructure.
TYPE_RESOLUTION Parameter for type resolution that can be applied to shallow entities.

Method Summary

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

ABSTRACT_SYNTAX_TREE

public static final ECheckParameter ABSTRACT_SYNTAX_TREE

Custom checks and custom check phases must require this parameter if they use tokens (ITokenElementContext.getTokens(ECodeViewOption)) or an abstract syntax tree (ITokenElementContext.getAbstractSyntaxTree(ECodeViewOption)) of the token element that is currently analyzed. If this parameter is missing, the token/shallow entity list is not initialized.

TYPE_RESOLUTION

public static final ECheckParameter TYPE_RESOLUTION

Parameter for type resolution that can be applied to shallow entities.

CLANG

public static final ECheckParameter CLANG

Parameter for using the Clang parser infrastructure.

Method Detail

values

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

Returns:

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

valueOf

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