com.github.dm.jrt.builder

Class InvocationConfiguration.Builder<TYPE>

java.lang.Object

com.github.dm.jrt.builder.InvocationConfiguration.Builder<TYPE>

Type Parameters:

TYPE - the configurable object type.

Enclosing class:

InvocationConfiguration

public static final class InvocationConfiguration.Builder<TYPE>
extends Object

Builder of invocation configurations.

Constructor Summary

Constructors

Constructor and Description
InvocationConfiguration.Builder(InvocationConfiguration.Configurable<? extends TYPE> configurable) Constructor.
InvocationConfiguration.Builder(InvocationConfiguration.Configurable<? extends TYPE> configurable, InvocationConfiguration initialConfiguration) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
TYPE	set() Sets the configuration and returns the configurable object.
InvocationConfiguration.Builder<TYPE>	with(InvocationConfiguration configuration) Applies the specified configuration to this builder.
InvocationConfiguration.Builder<TYPE>	withCoreInstances(int coreInstances) Sets the number of invocation instances, which represents the core pool of reusable invocations.
InvocationConfiguration.Builder<TYPE>	withInputMaxSize(int inputMaxSize) Sets the maximum number of data that the input channel can retain before they are consumed.
InvocationConfiguration.Builder<TYPE>	withInputOrder(InvocationConfiguration.OrderType orderType) Sets the order in which input data are collected from the input channel.
InvocationConfiguration.Builder<TYPE>	withInputTimeout(long timeout, TimeUnit timeUnit) Sets the timeout for an input channel to have room for additional data.
InvocationConfiguration.Builder<TYPE>	withInputTimeout(TimeDuration timeout) Sets the timeout for an input channel to have room for additional data.
InvocationConfiguration.Builder<TYPE>	withLog(Log log) Sets the log instance.
InvocationConfiguration.Builder<TYPE>	withLogLevel(Log.Level level) Sets the log level.
InvocationConfiguration.Builder<TYPE>	withMaxInstances(int maxInstances) Sets the max number of concurrently running invocation instances.
InvocationConfiguration.Builder<TYPE>	withOutputMaxSize(int outputMaxSize) Sets the maximum number of data that the result channel can retain before they are consumed.
InvocationConfiguration.Builder<TYPE>	withOutputOrder(InvocationConfiguration.OrderType orderType) Sets the order in which output data are collected from the result channel.
InvocationConfiguration.Builder<TYPE>	withOutputTimeout(long timeout, TimeUnit timeUnit) Sets the timeout for a result channel to have room for additional data.
InvocationConfiguration.Builder<TYPE>	withOutputTimeout(TimeDuration timeout) Sets the timeout for a result channel to have room for additional data.
InvocationConfiguration.Builder<TYPE>	withPriority(int priority) Sets the invocation priority.
InvocationConfiguration.Builder<TYPE>	withReadTimeout(long timeout, TimeUnit timeUnit) Sets the timeout for an invocation instance to produce a readable result. Note that this is just the initial configuration of the invocation, since the output timeout can be dynamically changed through the dedicated methods.
InvocationConfiguration.Builder<TYPE>	withReadTimeout(TimeDuration timeout) Sets the timeout for an invocation instance to produce a readable result.
InvocationConfiguration.Builder<TYPE>	withReadTimeoutAction(InvocationConfiguration.TimeoutActionType actionType) Sets the action to be taken if the timeout elapses before a result can be read from the output channel.
InvocationConfiguration.Builder<TYPE>	withRunner(Runner runner) Sets the asynchronous runner instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

InvocationConfiguration.Builder

public InvocationConfiguration.Builder(@NotNull
                               InvocationConfiguration.Configurable<? extends TYPE> configurable)

Constructor.

Parameters:

configurable - the configurable instance.

InvocationConfiguration.Builder

public InvocationConfiguration.Builder(@NotNull
                               InvocationConfiguration.Configurable<? extends TYPE> configurable,
                               @NotNull
                               InvocationConfiguration initialConfiguration)

Constructor.

Parameters:

configurable - the configurable instance.

initialConfiguration - the initial configuration.

Method Detail

set

@NotNull
public TYPE set()

Sets the configuration and returns the configurable object.

Returns:

the configurable object.

with

@NotNull
public InvocationConfiguration.Builder<TYPE> with(@Nullable
                                                 InvocationConfiguration configuration)

Applies the specified configuration to this builder. A null value means that all the configuration options need to be set to their default value, otherwise only the set options will be applied.

Parameters:

configuration - the invocation configuration.

Returns:

this builder.

withCoreInstances

@NotNull
public InvocationConfiguration.Builder<TYPE> withCoreInstances(int coreInstances)

Sets the number of invocation instances, which represents the core pool of reusable invocations. A DEFAULT value means that it is up to the specific implementation to choose a default one.

Parameters:

coreInstances - the core number of instances.

Returns:

this builder.

Throws:

IllegalArgumentException - if the number is negative.

withInputMaxSize

@NotNull
public InvocationConfiguration.Builder<TYPE> withInputMaxSize(int inputMaxSize)

Sets the maximum number of data that the input channel can retain before they are consumed. A DEFAULT value means that it is up to the specific implementation to choose a default one.

Parameters:

inputMaxSize - the maximum size.

Returns:

this builder.

Throws:

IllegalArgumentException - if the number is less than 1.

withInputOrder

@NotNull
public InvocationConfiguration.Builder<TYPE> withInputOrder(@Nullable
                                                           InvocationConfiguration.OrderType orderType)

Sets the order in which input data are collected from the input channel. A null value means that it is up to the specific implementation to choose a default one.
Note that this is just the initial configuration of the invocation, since the channel order can be dynamically changed through the dedicated methods.

Parameters:

orderType - the order type.

Returns:

this builder.

withInputTimeout

@NotNull
public InvocationConfiguration.Builder<TYPE> withInputTimeout(long timeout,
                                                             @NotNull
                                                             TimeUnit timeUnit)

Sets the timeout for an input channel to have room for additional data.

Parameters:

timeout - the timeout.

timeUnit - the timeout time unit.

Returns:

this builder.

Throws:

IllegalArgumentException - if the specified timeout is negative.

withInputTimeout

@NotNull
public InvocationConfiguration.Builder<TYPE> withInputTimeout(@Nullable
                                                             TimeDuration timeout)

Sets the timeout for an input channel to have room for additional data. A null value means that it is up to the specific implementation to choose a default one.

Parameters:

timeout - the timeout.

Returns:

this builder.

withLog

@NotNull
public InvocationConfiguration.Builder<TYPE> withLog(@Nullable
                                                    Log log)

Sets the log instance. A null value means that it is up to the specific implementation to choose a default one.

Parameters:

log - the log instance.

Returns:

this builder.

withLogLevel

@NotNull
public InvocationConfiguration.Builder<TYPE> withLogLevel(@Nullable
                                                         Log.Level level)

Sets the log level. A null value means that it is up to the specific implementation to choose a default one.

Parameters:

level - the log level.

Returns:

this builder.

withMaxInstances

@NotNull
public InvocationConfiguration.Builder<TYPE> withMaxInstances(int maxInstances)

Sets the max number of concurrently running invocation instances. A DEFAULT value means that it is up to the specific implementation to choose a default one.

Parameters:

maxInstances - the max number of instances.

Returns:

this builder.

Throws:

IllegalArgumentException - if the number is less than 1.

withOutputMaxSize

@NotNull
public InvocationConfiguration.Builder<TYPE> withOutputMaxSize(int outputMaxSize)

Sets the maximum number of data that the result channel can retain before they are consumed. A DEFAULT value means that it is up to the specific implementation to choose a default one.

Parameters:

outputMaxSize - the maximum size.

Returns:

this builder.

Throws:

IllegalArgumentException - if the number is less than 1.

withOutputOrder

@NotNull
public InvocationConfiguration.Builder<TYPE> withOutputOrder(@Nullable
                                                            InvocationConfiguration.OrderType orderType)

Sets the order in which output data are collected from the result channel. A null value means that it is up to the specific implementation to choose a default order one.
Note that this is just the initial configuration of the invocation, since the channel order can be dynamically changed through the dedicated methods.

Parameters:

orderType - the order type.

Returns:

this builder.

withOutputTimeout

@NotNull
public InvocationConfiguration.Builder<TYPE> withOutputTimeout(long timeout,
                                                              @NotNull
                                                              TimeUnit timeUnit)

Sets the timeout for a result channel to have room for additional data.

Parameters:

timeout - the timeout.

timeUnit - the timeout time unit.

Returns:

this builder.

Throws:

IllegalArgumentException - if the specified timeout is negative.

withOutputTimeout

@NotNull
public InvocationConfiguration.Builder<TYPE> withOutputTimeout(@Nullable
                                                              TimeDuration timeout)

Sets the timeout for a result channel to have room for additional data. A null value means that it is up to the specific implementation to choose a default one.

Parameters:

timeout - the timeout.

Returns:

this builder.

withPriority

@NotNull
public InvocationConfiguration.Builder<TYPE> withPriority(int priority)

Sets the invocation priority. A DEFAULT value means that the invocations will be executed with no specific priority.

Parameters:

priority - the priority.

Returns:

this builder.

See Also:

PriorityRunner

withReadTimeout

@NotNull
public InvocationConfiguration.Builder<TYPE> withReadTimeout(long timeout,
                                                            @NotNull
                                                            TimeUnit timeUnit)

Sets the timeout for an invocation instance to produce a readable result.
Note that this is just the initial configuration of the invocation, since the output timeout can be dynamically changed through the dedicated methods.

Parameters:

timeout - the timeout.

timeUnit - the timeout time unit.

Returns:

this builder.

Throws:

IllegalArgumentException - if the specified timeout is negative.

withReadTimeout

@NotNull
public InvocationConfiguration.Builder<TYPE> withReadTimeout(@Nullable
                                                            TimeDuration timeout)

Sets the timeout for an invocation instance to produce a readable result. A null value means that it is up to the specific implementation to choose a default one.
Note that this is just the initial configuration of the invocation, since the output timeout can be dynamically changed through the dedicated methods.

Parameters:

timeout - the timeout.

Returns:

this builder.

withReadTimeoutAction

@NotNull
public InvocationConfiguration.Builder<TYPE> withReadTimeoutAction(@Nullable
                                                                  InvocationConfiguration.TimeoutActionType actionType)

Sets the action to be taken if the timeout elapses before a result can be read from the output channel. A null value means that it is up to the specific implementation to choose a default one.
Note that this is just the initial configuration of the invocation, since the output timeout action can be dynamically changed through the dedicated methods.

Parameters:

actionType - the action type.

Returns:

this builder.

withRunner

@NotNull
public InvocationConfiguration.Builder<TYPE> withRunner(@Nullable
                                                       Runner runner)

Sets the asynchronous runner instance. A null value means that it is up to the specific implementation to choose a default one.

Parameters:

runner - the runner instance.

Returns:

this builder.