oracle.pgx.config

Class AnalysisTaskConfigBuilder

java.lang.Object

oracle.pgx.config.AnalysisTaskConfigBuilder

@Generated(value={"common/src/templates/ConfigBuilder.stg","common/common.gradle"})
public final class AnalysisTaskConfigBuilder
extends java.lang.Object

Builder for AnalysisTaskConfig.

Constructor Summary

Constructors

Constructor and Description
AnalysisTaskConfigBuilder() Constructs an empty AnalysisTaskConfigBuilder
AnalysisTaskConfigBuilder(AnalysisTaskConfig config) Constructs a AnalysisTaskConfigBuilder initialized with the values from the given config
AnalysisTaskConfigBuilder(AnalysisTaskConfigBuilder builder) Constructs a AnalysisTaskConfigBuilder initialized with the values from the given builder
AnalysisTaskConfigBuilder(java.util.Map<AnalysisTaskConfig.Field,java.lang.Object> values) Constructs a AnalysisTaskConfigBuilder initialized with the values from the given map

Method Summary

Modifier and Type	Method and Description
AnalysisTaskConfig	build() Builds the AnalysisTaskConfig with a parentPath of null.
AnalysisTaskConfig	build(java.lang.String parentPath) Builds the AnalysisTaskConfig.
static AnalysisTaskConfig	buildAnalysisTaskConfig(java.util.function.Consumer<AnalysisTaskConfigBuilder> builderSetup) Builds a AnalysisTaskConfig in-place
AnalysisTaskConfigBuilder	clear() Clears all values from the builder
java.util.Map<AnalysisTaskConfig.Field,java.lang.Object>	getValues()
AnalysisTaskConfigBuilder	putAll(AnalysisTaskConfig config) Puts all values from the given config into this builder
AnalysisTaskConfigBuilder	putAll(java.util.Map<AnalysisTaskConfig.Field,java.lang.Object> values) Puts all values from the given map into this builder.
AnalysisTaskConfigBuilder	setMaxThreads(int maxThreads) a hard limit on the number of threads to use for a task.
AnalysisTaskConfigBuilder	setPriority(TaskPriority priority) the priority of the task.
AnalysisTaskConfigBuilder	setWeight(int weight) the weight of the task.
java.io.InputStream	toInputStream()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AnalysisTaskConfigBuilder

public AnalysisTaskConfigBuilder()

Constructs an empty AnalysisTaskConfigBuilder

AnalysisTaskConfigBuilder

public AnalysisTaskConfigBuilder(AnalysisTaskConfig config)

Constructs a AnalysisTaskConfigBuilder initialized with the values from the given config

Parameters:

config - the configuration to take the values from

AnalysisTaskConfigBuilder

public AnalysisTaskConfigBuilder(AnalysisTaskConfigBuilder builder)

Constructs a AnalysisTaskConfigBuilder initialized with the values from the given builder

Parameters:

builder - the builder to take the values from

AnalysisTaskConfigBuilder

public AnalysisTaskConfigBuilder(java.util.Map<AnalysisTaskConfig.Field,java.lang.Object> values)

Constructs a AnalysisTaskConfigBuilder initialized with the values from the given map

Parameters:

values - a map containing configuration values

Method Detail

build

public AnalysisTaskConfig build()

Builds the AnalysisTaskConfig with a parentPath of null.

Returns:

An instance of AnalysisTaskConfig

See Also:

build(String)

build

public AnalysisTaskConfig build(java.lang.String parentPath)

Builds the AnalysisTaskConfig.

Parameters:

parentPath - if not null, resolves relative paths against this parentPath

Returns:

an instance of AnalysisTaskConfig

buildAnalysisTaskConfig

public static AnalysisTaskConfig buildAnalysisTaskConfig(java.util.function.Consumer<AnalysisTaskConfigBuilder> builderSetup)

Builds a AnalysisTaskConfig in-place

Parameters:

builderSetup - a consumer to setup a newly created AnalysisTaskConfig

clear

public AnalysisTaskConfigBuilder clear()

Clears all values from the builder

getValues

public java.util.Map<AnalysisTaskConfig.Field,java.lang.Object> getValues()

Returns:

the raw config values

putAll

public AnalysisTaskConfigBuilder putAll(AnalysisTaskConfig config)

Puts all values from the given config into this builder

Parameters:

config - the config to take the values from

putAll

public AnalysisTaskConfigBuilder putAll(java.util.Map<AnalysisTaskConfig.Field,java.lang.Object> values)

Puts all values from the given map into this builder.

Parameters:

values - the values to put in the builder

setMaxThreads

public AnalysisTaskConfigBuilder setMaxThreads(int maxThreads)

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

setPriority

public AnalysisTaskConfigBuilder setPriority(TaskPriority 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

setWeight

public AnalysisTaskConfigBuilder setWeight(int 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.

toInputStream

public java.io.InputStream toInputStream()

Returns:

an InputStream representing the config

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object