org.jgrapes.io.events

Class Output<T extends Buffer>

java.lang.Object

org.jgrapes.core.internal.EventBase<T>

org.jgrapes.core.Event<Void>

org.jgrapes.io.events.IOEvent<T>

org.jgrapes.io.events.Output<T>

All Implemented Interfaces:

Future<Void>, Associator, Eligible

public class Output<T extends Buffer>
extends IOEvent<T>

This event signals that a new chunk of internally generated data is to be forwarded to some destination. This type of event is commonly used for data flowing out of the application.

Field Summary

Fields inherited from class org.jgrapes.core.internal.EventBase

completed, completionEvents

Constructor Summary

Constructors

Constructor and Description
Output(Output<T> event) Create a new event from an existing event.

Method Summary

Modifier and Type	Method and Description
static Output<ByteBuffer>	from(byte[] data, boolean endOfRecord) Convenience method that creates a Output<ByteBuffer> event from a byte[].
static Output<CharBuffer>	from(String data, boolean endOfRecord) Convenience method that creates a Output<CharBuffer> event from a String.
static <B extends Buffer> Output<B>	fromSink(ManagedBuffer<B> buffer, boolean endOfRecord) Create a new event with the given buffer.
static <B extends Buffer> Output<B>	fromSource(ManagedBuffer<B> buffer, boolean endOfRecord) Create a new event with the given buffer.

Methods inherited from class org.jgrapes.io.events.IOEvent

buffer, data, handled, hasRemaining, isEndOfRecord, remaining, toString

Methods inherited from class org.jgrapes.core.Event

addCompletionEvent, associated, cancel, channels, channels, completionEvents, currentResults, defaultCriterion, forChannels, get, get, handlingError, isCancelled, isDone, isEligibleFor, isStopped, processedBy, results, results, setAssociated, setChannels, setRequiresResult, setResult, stop, tieTo

Methods inherited from class org.jgrapes.core.internal.EventBase

disableTracking, enqueued, firstResultAssigned, isTracked

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jgrapes.core.Associator

associated, associated, associated

Constructor Detail

Output

public Output(Output<T> event)

Create a new event from an existing event. This constructor is useful if the data is to be forwarded to another channel by a new event.

The buffer is reused in the new event (the lock count is incremented).

Parameters:

event - the existing event

Method Detail

fromSource

public static <B extends Buffer> Output<B> fromSource(ManagedBuffer<B> buffer,
                                                      boolean endOfRecord)

Create a new event with the given buffer. The buffer must have been prepared for invoking get-methods.

Parameters:

buffer - the buffer with the data

endOfRecord - if the event ends a data record

fromSink

public static <B extends Buffer> Output<B> fromSink(ManagedBuffer<B> buffer,
                                                    boolean endOfRecord)

Create a new event with the given buffer. Creating the event flips the buffer, which is assumed to have been used for collecting data up to now.

Parameters:

buffer - the buffer with the data

endOfRecord - if the event ends a data record

from

public static Output<CharBuffer> from(String data,
                                      boolean endOfRecord)

Convenience method that creates a Output<CharBuffer> event from a String.

Parameters:

data - the string to wrap

endOfRecord - if the event ends a data record

Returns:

the event

from

public static Output<ByteBuffer> from(byte[] data,
                                      boolean endOfRecord)

Convenience method that creates a Output<ByteBuffer> event from a byte[].

Parameters:

data - the array to wrap

endOfRecord - if the event ends a data record

Returns:

the event