org.atmosphere.wasync

Class Decoder.Decoded<T>

java.lang.Object

org.atmosphere.wasync.Decoder.Decoded<T>

Type Parameters:

T - destination type

Enclosing interface:

Decoder<U,T>

public static final class Decoder.Decoded<T>
extends java.lang.Object

A Decoder may return an instance of a Decoded object to prevent some messages from being delivered to a Function, by returning a ABORT instance. Returning an instance of Decoded with the action set to Decoder.Decoded.ACTION.CONTINUE will allow dispatching messages to Function

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Decoder.Decoded.ACTION

Field Summary

Fields

Modifier and Type	Field and Description
static Decoder.Decoded	ABORT Use this object to prevent the delivering of messages to Function

Constructor Summary

Constructors

Constructor and Description
Decoded(T decodedMessage) Create a decoded object with action set to Decoder.Decoded.ACTION.CONTINUE
Decoded(T decodedMessage, Decoder.Decoded.ACTION action) Create a decoded object

Method Summary

Modifier and Type	Method and Description
Decoder.Decoded.ACTION	action() Return the action.
T	decoded() Return the decoded message.

Methods inherited from class java.lang.Object

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

Field Detail

ABORT

public static final Decoder.Decoded ABORT

Use this object to prevent the delivering of messages to Function

Constructor Detail

Decoded

public Decoded(T decodedMessage,
               Decoder.Decoded.ACTION action)

Create a decoded object

Parameters:

decodedMessage - the decoded message

action - the action

Decoded

public Decoded(T decodedMessage)

Create a decoded object with action set to Decoder.Decoded.ACTION.CONTINUE

Parameters:

decodedMessage - the decoded Message

Method Detail

decoded

public T decoded()

Return the decoded message.

Returns:

the decoded message.

action

public Decoder.Decoded.ACTION action()

Return the action.

Returns:

the action.