com.github.dm.jrt.builder

Class ChannelConfiguration.Builder<TYPE>

java.lang.Object

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

Type Parameters:

TYPE - the configurable object type.

Enclosing class:

ChannelConfiguration

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

Builder of channel configurations.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
TYPE	set() Sets the configuration and returns the configurable object.
ChannelConfiguration.Builder<TYPE>	with(ChannelConfiguration configuration) Applies the specified configuration to this builder.
ChannelConfiguration.Builder<TYPE>	withAsyncRunner(Runner runner) Sets the asynchronous runner instance.
ChannelConfiguration.Builder<TYPE>	withChannelMaxSize(int maxSize) Sets the maximum number of data that the channel can retain before they are consumed.
ChannelConfiguration.Builder<TYPE>	withChannelOrder(InvocationConfiguration.OrderType orderType) Sets the order in which data are collected from the channel.
ChannelConfiguration.Builder<TYPE>	withChannelTimeout(long timeout, TimeUnit timeUnit) Sets the timeout for the channel to have room for additional data.
ChannelConfiguration.Builder<TYPE>	withChannelTimeout(TimeDuration timeout) Sets the timeout for the channel to have room for additional data.
ChannelConfiguration.Builder<TYPE>	withLog(Log log) Sets the log instance.
ChannelConfiguration.Builder<TYPE>	withLogLevel(Log.Level level) Sets the log level.
ChannelConfiguration.Builder<TYPE>	withReadTimeout(long timeout, TimeUnit timeUnit) Sets the timeout for the channel instance to produce a readable output. Note that this is just the initial configuration, since the output timeout can be dynamically changed through the dedicated methods.
ChannelConfiguration.Builder<TYPE>	withReadTimeout(TimeDuration timeout) Sets the timeout for the channel instance to produce a readable output.
ChannelConfiguration.Builder<TYPE>	withReadTimeoutAction(InvocationConfiguration.TimeoutActionType actionType) Sets the action to be taken if the timeout elapses before an output can be read from the output channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelConfiguration.Builder

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

Constructor.

Parameters:

configurable - the configurable instance.

ChannelConfiguration.Builder

public ChannelConfiguration.Builder(@NotNull
                            ChannelConfiguration.Configurable<? extends TYPE> configurable,
                            @NotNull
                            ChannelConfiguration 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 ChannelConfiguration.Builder<TYPE> with(@Nullable
                                              ChannelConfiguration 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 channel configuration.

Returns:

this builder.

withAsyncRunner

@NotNull
public ChannelConfiguration.Builder<TYPE> withAsyncRunner(@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.

withChannelMaxSize

@NotNull
public ChannelConfiguration.Builder<TYPE> withChannelMaxSize(int maxSize)

Sets the maximum number of data that the 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:

maxSize - the maximum size.

Returns:

this builder.

Throws:

IllegalArgumentException - if the number is less than 1.

withChannelOrder

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

Sets the order in which data are collected from the 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, since the channel order can be dynamically changed through the dedicated methods.

Parameters:

orderType - the order type.

Returns:

this builder.

withChannelTimeout

@NotNull
public ChannelConfiguration.Builder<TYPE> withChannelTimeout(long timeout,
                                                            @NotNull
                                                            TimeUnit timeUnit)

Sets the timeout for the 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.

withChannelTimeout

@NotNull
public ChannelConfiguration.Builder<TYPE> withChannelTimeout(@Nullable
                                                            TimeDuration timeout)

Sets the timeout for the 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 ChannelConfiguration.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 ChannelConfiguration.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.

withReadTimeout

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

Sets the timeout for the channel instance to produce a readable output.
Note that this is just the initial configuration, 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 ChannelConfiguration.Builder<TYPE> withReadTimeout(@Nullable
                                                         TimeDuration timeout)

Sets the timeout for the channel instance to produce a readable output. 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, since the output timeout can be dynamically changed through the dedicated methods.

Parameters:

timeout - the timeout.

Returns:

this builder.

withReadTimeoutAction

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

Sets the action to be taken if the timeout elapses before an output 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, since the output timeout action can be dynamically changed through the dedicated methods.

Parameters:

actionType - the action type.

Returns:

this builder.