org.apache.flink.api.common

Enum CodeAnalysisMode

java.lang.Object

java.lang.Enum<CodeAnalysisMode>

org.apache.flink.api.common.CodeAnalysisMode

All Implemented Interfaces:

Serializable, Comparable<CodeAnalysisMode>

public enum CodeAnalysisMode
extends Enum<CodeAnalysisMode>

Specifies to which extent user-defined functions are analyzed in order to give the Flink optimizer an insight of UDF internals and inform the user about common implementation mistakes. The analyzer gives hints about: - ForwardedFields semantic properties - Warnings if static fields are modified by a Function - Warnings if a FilterFunction modifies its input objects - Warnings if a Function returns null - Warnings if a tuple access uses a wrong index - Information about the number of object creations (for manual optimization)

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLE Code analysis does not take place.
HINT Hints for improvement of the program are printed to the log.
OPTIMIZE The program will be automatically optimized with knowledge from code analysis.

Method Summary

Methods

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

DISABLE

public static final CodeAnalysisMode DISABLE

Code analysis does not take place.

HINT

public static final CodeAnalysisMode HINT

Hints for improvement of the program are printed to the log.

OPTIMIZE

public static final CodeAnalysisMode OPTIMIZE

The program will be automatically optimized with knowledge from code analysis.

Method Detail

values

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

Returns:

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

valueOf

public static CodeAnalysisMode valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null