oracle.pgx.config

Enum AnalysisTaskConfig.Field

java.lang.Object

java.lang.Enum<AnalysisTaskConfig.Field>

oracle.pgx.config.AnalysisTaskConfig.Field

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AnalysisTaskConfig.Field>, ConfigField

Enclosing class:

AnalysisTaskConfig

public static enum AnalysisTaskConfig.Field
extends java.lang.Enum<AnalysisTaskConfig.Field>
implements ConfigField

Fields of analysis task config

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAX_THREADS a hard limit on the number of threads to use for a task.
PRIORITY the priority of the task.
WEIGHT the weight of the task.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getDefaultVal() Gets the default value of this field.
java.util.List<java.lang.String>	getKeyAliases() Gets the key aliases of this field which are also recognized during parsing.
java.util.List<java.lang.String>	getSingletonListKeyAliases() Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
java.lang.Class<?>	getType() Gets the type of this field.
boolean	isArray() Checks if this field is an array.
boolean	isPath() Checks if this field is a path.
boolean	isRequired() Checks if this field is required.
java.lang.String	toKey() Get the key of this field, which is how this field is represented in serialized form.
java.lang.String	toString()
static AnalysisTaskConfig.Field	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AnalysisTaskConfig.Field[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.pgx.config.ConfigField

isEnum, isPrimitive

Enum Constant Detail

MAX_THREADS

public static final AnalysisTaskConfig.Field MAX_THREADS

a hard limit on the number of threads to use for a task.

PRIORITY

public static final AnalysisTaskConfig.Field PRIORITY

the priority of the task. Threads are given to the task with the highest priority at the moment of execution. If there are more threads that have the highest priority, threads are given to the tasks according to their weight

WEIGHT

public static final AnalysisTaskConfig.Field WEIGHT

the weight of the task. Threads are given to tasks proportionally to their weight. Tasks with higher weight will get more threads than tasks with lower weight. Tasks with the same weight will get the same amount of threads.

Method Detail

getDefaultVal

public java.lang.Object getDefaultVal()

Description copied from interface: ConfigField

Gets the default value of this field.

Specified by:

getDefaultVal in interface ConfigField

Returns:

the default value

getKeyAliases

public java.util.List<java.lang.String> getKeyAliases()

Description copied from interface: ConfigField

Gets the key aliases of this field which are also recognized during parsing.

Specified by:

getKeyAliases in interface ConfigField

Returns:

the key aliases

getSingletonListKeyAliases

public java.util.List<java.lang.String> getSingletonListKeyAliases()

Description copied from interface: ConfigField

Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.

Specified by:

getSingletonListKeyAliases in interface ConfigField

Returns:

the singleton list key aliases

getType

public java.lang.Class<?> getType()

Description copied from interface: ConfigField

Gets the type of this field.

Specified by:

getType in interface ConfigField

Returns:

the type

isArray

public boolean isArray()

Description copied from interface: ConfigField

Checks if this field is an array.

Specified by:

isArray in interface ConfigField

Returns:

true, if array

isPath

public boolean isPath()

Description copied from interface: ConfigField

Checks if this field is a path.

Specified by:

isPath in interface ConfigField

Returns:

true, if path

isRequired

public boolean isRequired()

Description copied from interface: ConfigField

Checks if this field is required.

Specified by:

isRequired in interface ConfigField

Returns:

true, if required

toKey

public java.lang.String toKey()

Description copied from interface: ConfigField

Get the key of this field, which is how this field is represented in serialized form.

Specified by:

toKey in interface ConfigField

Returns:

the key.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<AnalysisTaskConfig.Field>

valueOf

public static AnalysisTaskConfig.Field 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

values

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

Returns:

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