com.github.dm.jrt.builder

Class ChannelConfiguration

java.lang.Object

com.github.dm.jrt.builder.ChannelConfiguration

public final class ChannelConfiguration
extends Object

Class storing the channel configuration.

Each instance is immutable, thus, in order to modify a configuration parameter, a new builder must be created starting from the specific configuration.

The configuration has an asynchronous runner associated.
The number of input data buffered in the channel can be limited in order to avoid excessive memory consumption. In case the maximum number is reached when passing an input, the call blocks until enough data are consumed or the specified timeout elapses. In the latter case, a TimeoutException will be thrown.
By default the timeout is set to 0 so to avoid unexpected deadlocks.
The order of input data is not guaranteed. Nevertheless, it is possible to force data to be delivered in the same order as they are passed to the channels, at the cost of a slightly increase in memory usage and computation.

Created by davide-maestroni on 07/03/2015.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChannelConfiguration.Builder<TYPE> Builder of channel configurations.
static interface	ChannelConfiguration.Configurable<TYPE> Interface defining a configurable object.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT Constant indicating the default value of an integer attribute.
static ChannelConfiguration	DEFAULT_CONFIGURATION Empty configuration constant. The configuration has all the options set to their default.

Method Summary

Methods

Modifier and Type	Method and Description
static ChannelConfiguration.Builder<ChannelConfiguration>	builder() Returns a channel configuration builder.
ChannelConfiguration.Builder<ChannelConfiguration>	builderFrom() Returns a channel configuration builder initialized with this configuration.
static ChannelConfiguration.Builder<ChannelConfiguration>	builderFrom(ChannelConfiguration initialConfiguration) Returns a channel configuration builder initialized with the specified configuration.
boolean	equals(Object o)
Runner	getAsyncRunnerOr(Runner valueIfNotSet) Returns the runner used for asynchronous inputs (null by default).
int	getChannelMaxSizeOr(int valueIfNotSet) Returns the maximum number of buffered data (DEFAULT by default).
InvocationConfiguration.OrderType	getChannelOrderTypeOr(InvocationConfiguration.OrderType valueIfNotSet) Returns the data order (null by default).
TimeDuration	getChannelTimeoutOr(TimeDuration valueIfNotSet) Returns the maximum timeout while waiting for an object to be passed to the channel (null by default).
Log.Level	getLogLevelOr(Log.Level valueIfNotSet) Returns the log level (null by default).
Log	getLogOr(Log valueIfNotSet) Returns the log instance (null by default).
InvocationConfiguration.TimeoutActionType	getReadTimeoutActionOr(InvocationConfiguration.TimeoutActionType valueIfNotSet) Returns the action to be taken if the timeout elapses before a readable output is available (null by default).
TimeDuration	getReadTimeoutOr(TimeDuration valueIfNotSet) Returns the timeout for the channel to produce a readable output (null by default).
int	hashCode()
InvocationConfiguration	toInputChannelConfiguration() Converts this configuration into an invocation one by applying the matching options to the invocation input channel.
InvocationConfiguration	toInvocationConfiguration() Converts this configuration into an invocation one by mapping the matching options.
InvocationConfiguration	toOutputChannelConfiguration() Converts this configuration into an invocation one by applying the matching options to the invocation output channel.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT

public static final int DEFAULT

Constant indicating the default value of an integer attribute.

See Also:

Constant Field Values

DEFAULT_CONFIGURATION

public static final ChannelConfiguration DEFAULT_CONFIGURATION

Empty configuration constant.
The configuration has all the options set to their default.

Method Detail

builder

@NotNull
public static ChannelConfiguration.Builder<ChannelConfiguration> builder()

Returns a channel configuration builder.

Returns:

the builder.

builderFrom

@NotNull
public static ChannelConfiguration.Builder<ChannelConfiguration> builderFrom(@Nullable
                                                                     ChannelConfiguration initialConfiguration)

Returns a channel configuration builder initialized with the specified configuration.

Parameters:

initialConfiguration - the initial configuration.

Returns:

the builder.

builderFrom

@NotNull
public ChannelConfiguration.Builder<ChannelConfiguration> builderFrom()

Returns a channel configuration builder initialized with this configuration.

Returns:

the builder.

getAsyncRunnerOr

public Runner getAsyncRunnerOr(@Nullable
                      Runner valueIfNotSet)

Returns the runner used for asynchronous inputs (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the runner instance.

getChannelMaxSizeOr

public int getChannelMaxSizeOr(int valueIfNotSet)

Returns the maximum number of buffered data (DEFAULT by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the maximum size.

getChannelOrderTypeOr

public InvocationConfiguration.OrderType getChannelOrderTypeOr(@Nullable
                                                      InvocationConfiguration.OrderType valueIfNotSet)

Returns the data order (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the order type.

getChannelTimeoutOr

public TimeDuration getChannelTimeoutOr(@Nullable
                               TimeDuration valueIfNotSet)

Returns the maximum timeout while waiting for an object to be passed to the channel (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the timeout.

getLogLevelOr

public Log.Level getLogLevelOr(@Nullable
                      Log.Level valueIfNotSet)

Returns the log level (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the log level.

getLogOr

public Log getLogOr(@Nullable
           Log valueIfNotSet)

Returns the log instance (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the log instance.

getReadTimeoutActionOr

public InvocationConfiguration.TimeoutActionType getReadTimeoutActionOr(@Nullable
                                                               InvocationConfiguration.TimeoutActionType valueIfNotSet)

Returns the action to be taken if the timeout elapses before a readable output is available (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the action type.

getReadTimeoutOr

public TimeDuration getReadTimeoutOr(@Nullable
                            TimeDuration valueIfNotSet)

Returns the timeout for the channel to produce a readable output (null by default).

Parameters:

valueIfNotSet - the default value if none was set.

Returns:

the timeout.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toInputChannelConfiguration

@NotNull
public InvocationConfiguration toInputChannelConfiguration()

Converts this configuration into an invocation one by applying the matching options to the invocation input channel.

Returns:

the invocation configuration.

toInvocationConfiguration

@NotNull
public InvocationConfiguration toInvocationConfiguration()

Converts this configuration into an invocation one by mapping the matching options.

Returns:

the invocation configuration.

toOutputChannelConfiguration

@NotNull
public InvocationConfiguration toOutputChannelConfiguration()

Converts this configuration into an invocation one by applying the matching options to the invocation output channel.

Returns:

the invocation configuration.