SingleConnectionBuilder (jenjin-io 0.4.0-alpha API)

java.lang.Object
- com.jenjinstudios.io.connection.SingleConnectionBuilder<T>

public class SingleConnectionBuilder<T extends ExecutionContext>
extends java.lang.Object

Used to configure and create a Connection.

Constructor Summary

Constructors
Constructor and Description

SingleConnectionBuilder()

Constructors
Constructor and Description
`SingleConnectionBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Connection<T>`	`build()` Build a connection using all the values supplied to this builder.
`SingleConnectionBuilder<T>`	`withContextualTask(java.util.function.Consumer<T> task)` Build a connection that includes the given contextual task to be executed synchronously with message execution.
`SingleConnectionBuilder<T>`	`withContextualTasks(java.util.function.Consumer<T>... tasks)` Build a connection that includes the given contextual task to be executed synchronously with message execution.
`SingleConnectionBuilder<T>`	`withContextualTasks(java.lang.Iterable<java.util.function.Consumer<T>> tasks)` Build a connection that includes the given contextual task to be executed synchronously with message execution.
`SingleConnectionBuilder<T>`	`withErrorCallback(java.util.function.BiConsumer<Connection<T>,java.lang.Throwable> callback)` Build a connection with the given error callback function.
`SingleConnectionBuilder<T>`	`withExecutionContext(T context)` Build a connection with the given ExecutionContext.
`SingleConnectionBuilder<T>`	`withInputStream(java.io.InputStream inputStream)` Build a connection with the given InputStream.
`SingleConnectionBuilder<T>`	`withMessageIOFactory(MessageIOFactory factory)` Use the given MessageIOFactory to create MessageReader and MessageWriter instances from Java Input and Output streams.
`SingleConnectionBuilder<T>`	`withMessageReader(MessageReader reader)` Build a connection with the given InputStream.
`SingleConnectionBuilder<T>`	`withMessageReaderFactory(MessageReaderFactory factory)` Use the specified MessageReaderFactory to build a MessageReader from any InputStreams.
`SingleConnectionBuilder<T>`	`withMessageWriter(MessageWriter writer)` Build a connection with the given OutputStream.
`SingleConnectionBuilder<T>`	`withMessageWriterFactory(MessageWriterFactory factory)` Use the specified MessageWriterFactory to build a MessageWriter from any OutputStreams.
`SingleConnectionBuilder<T>`	`withOutputStream(java.io.OutputStream outputStream)` Build a connection with the given OutputStream.
`SingleConnectionBuilder<T>`	`withShutdownCallback(java.util.function.Consumer<Connection<T>> callback)` Build a connection that will invoke the given consumer when shutting down with itself as a parameter.
`SingleConnectionBuilder<T>`	`withShutdownCallbacks(java.lang.Iterable<java.util.function.Consumer<Connection<T>>> callbacks)` Build a connection that will invoke the given consumers when shutting down with itself as a parameter.
`SingleConnectionBuilder<T>`	`withSocket(java.net.Socket socket)` Construct a new ConnectionBuilder that will establish a connection over the given socket.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SingleConnectionBuilder
```
public SingleConnectionBuilder()
```
- Method Detail
  - build
```
public Connection<T> build()
```
    Build a connection using all the values supplied to this builder.
    
    Returns:
    
    A connection built with all the values supplied to this builder.
  - withSocket
```
public SingleConnectionBuilder<T> withSocket(java.net.Socket socket)
                                      throws java.io.IOException
```
    Construct a new ConnectionBuilder that will establish a connection over the given socket.
    
    Parameters:
    
    socket - The socket over which the connection will be made.
    
    Returns:
    
    This ConnectionBuilder.
    
    Throws:
    
    java.io.IOException - If there is an exception when creating streams from the given socket.
  - withMessageIOFactory
```
public SingleConnectionBuilder<T> withMessageIOFactory(MessageIOFactory factory)
```
    Use the given MessageIOFactory to create MessageReader and MessageWriter instances from Java Input and Output streams.
    
    Parameters:
    
    factory - The MessageIOFactory.
    
    Returns:
    
    This ConnectionBuilder.
  - withInputStream
```
public SingleConnectionBuilder<T> withInputStream(java.io.InputStream inputStream)
```
    Build a connection with the given InputStream.
    
    Parameters:
    
    inputStream - The stream the Connection will use to read messages.
    
    Returns:
    
    This ConnectionBuilder
  - withOutputStream
```
public SingleConnectionBuilder<T> withOutputStream(java.io.OutputStream outputStream)
```
    Build a connection with the given OutputStream.
    
    Parameters:
    
    outputStream - The output stream the Connection will use to write messages.
    
    Returns:
    
    This ConnectionBuilder
  - withMessageReader
```
public SingleConnectionBuilder<T> withMessageReader(MessageReader reader)
```
    Build a connection with the given InputStream.
    
    Parameters:
    
    reader - The stream the Connection will use to read messages.
    
    Returns:
    
    This ConnectionBuilder
  - withMessageWriter
```
public SingleConnectionBuilder<T> withMessageWriter(MessageWriter writer)
```
    Build a connection with the given OutputStream.
    
    Parameters:
    
    writer - The output stream the Connection will use to write messages.
    
    Returns:
    
    This ConnectionBuilder
  - withExecutionContext
```
public SingleConnectionBuilder<T> withExecutionContext(T context)
```
    Build a connection with the given ExecutionContext.
    
    Parameters:
    
    context - The context in which the Connection will execute messages.
    
    Returns:
    
    This ConnectionBuilder.
  - withErrorCallback
```
public SingleConnectionBuilder<T> withErrorCallback(java.util.function.BiConsumer<Connection<T>,java.lang.Throwable> callback)
```
    Build a connection with the given error callback function.
    
    Parameters:
    
    callback - The Consumer (accepting a Connection and Throwable) that will be invoked when an error is encountered.
    
    Returns:
    
    This ConnectionBuilder.
  - withContextualTask
```
public SingleConnectionBuilder<T> withContextualTask(java.util.function.Consumer<T> task)
```
    Build a connection that includes the given contextual task to be executed synchronously with message execution.
    
    Parameters:
    
    task - The task to be executed; a Consumer accepting an ExecutionContext.
    
    Returns:
    
    This ConnectionBuilder.
  - withContextualTasks
```
@SafeVarargs
public final SingleConnectionBuilder<T> withContextualTasks(java.util.function.Consumer<T>... tasks)
```
    Build a connection that includes the given contextual task to be executed synchronously with message execution.
    
    Parameters:
    
    tasks - The tasks to be executed; Consumers accepting an ExecutionContext.
    
    Returns:
    
    This ConnectionBuilder.
  - withContextualTasks
```
public SingleConnectionBuilder<T> withContextualTasks(java.lang.Iterable<java.util.function.Consumer<T>> tasks)
```
    Build a connection that includes the given contextual task to be executed synchronously with message execution.
    
    Parameters:
    
    tasks - The tasks to be executed; Consumers accepting an ExecutionContext.
    
    Returns:
    
    This ConnectionBuilder.
  - withShutdownCallbacks
```
public SingleConnectionBuilder<T> withShutdownCallbacks(java.lang.Iterable<java.util.function.Consumer<Connection<T>>> callbacks)
```
    Build a connection that will invoke the given consumers when shutting down with itself as a parameter.
    
    Parameters:
    
    callbacks - The consumers.
    
    Returns:
    
    This ConnectionBuilder.
  - withShutdownCallback
```
public SingleConnectionBuilder<T> withShutdownCallback(java.util.function.Consumer<Connection<T>> callback)
```
    Build a connection that will invoke the given consumer when shutting down with itself as a parameter.
    
    Parameters:
    
    callback - The consumer
    
    Returns:
    
    This ConnectionBuilder.
  - withMessageReaderFactory
```
public SingleConnectionBuilder<T> withMessageReaderFactory(MessageReaderFactory factory)
```
    Use the specified MessageReaderFactory to build a MessageReader from any InputStreams.
    
    Parameters:
    
    factory - The MessageReaderFactory.
    
    Returns:
    
    This SingleConnectionBuilder.
  - withMessageWriterFactory
```
public SingleConnectionBuilder<T> withMessageWriterFactory(MessageWriterFactory factory)
```
    Use the specified MessageWriterFactory to build a MessageWriter from any OutputStreams.
    
    Parameters:
    
    factory - The MessageWriterFactory.
    
    Returns:
    
    This SingleConnectionBuilder.

Class SingleConnectionBuilder<T extends ExecutionContext>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SingleConnectionBuilder

Method Detail

build

withSocket

withMessageIOFactory

withInputStream

withOutputStream

withMessageReader

withMessageWriter

withExecutionContext

withErrorCallback

withContextualTask

withContextualTasks

withContextualTasks

withShutdownCallbacks

withShutdownCallback

withMessageReaderFactory

withMessageWriterFactory