Package org.apache.mina.core.write

Class DefaultWriteRequest

java.lang.Object

org.apache.mina.core.write.DefaultWriteRequest

All Implemented Interfaces:

WriteRequest

Direct Known Subclasses:

ProtocolCodecFilter.EncodedWriteRequest

public class DefaultWriteRequest
extends Object
implements WriteRequest

The default implementation of WriteRequest.

Field Summary

Fields

Modifier and Type	Field	Description
private final SocketAddress	destination
static final byte[]	EMPTY_MESSAGE	An empty message
private final WriteFuture	future
private final Object	message
private static final WriteFuture	UNUSED_FUTURE	An empty FUTURE

Constructor Summary

Constructors

Constructor	Description
DefaultWriteRequest(Object message)	Creates a new instance without WriteFuture.
DefaultWriteRequest(Object message, WriteFuture future)	Creates a new instance with WriteFuture.
DefaultWriteRequest(Object message, WriteFuture future, SocketAddress destination)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
SocketAddress	getDestination()	Returns the destination of this write request.
WriteFuture	getFuture()
Object	getMessage()
WriteRequest	getOriginalRequest()
boolean	isEncoded()	Tells if the current message has been encoded
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_MESSAGE

public static final byte[] EMPTY_MESSAGE

An empty message

UNUSED_FUTURE

private static final WriteFuture UNUSED_FUTURE

An empty FUTURE

message

private final Object message

future

private final WriteFuture future

destination

private final SocketAddress destination

Constructor Details

DefaultWriteRequest

public DefaultWriteRequest(Object message)

Creates a new instance without WriteFuture. You'll get an instance of WriteFuture even if you called this constructor because getFuture() will return a bogus future.

Parameters:

message - The message that will be written

DefaultWriteRequest

public DefaultWriteRequest(Object message,
 WriteFuture future)

Creates a new instance with WriteFuture.

Parameters:

message - The message that will be written

future - The associated WriteFuture

DefaultWriteRequest

public DefaultWriteRequest(Object message,
 WriteFuture future,
 SocketAddress destination)

Creates a new instance.

Parameters:

message - a message to write

future - a future that needs to be notified when an operation is finished

destination - the destination of the message. This property will be ignored unless the transport supports it.

Method Details

getFuture

public WriteFuture getFuture()

Specified by:

getFuture in interface WriteRequest

Returns:

WriteFuture that is associated with this write request.

getMessage

public Object getMessage()

Specified by:

getMessage in interface WriteRequest

Returns:

a message object to be written.

getOriginalRequest

public WriteRequest getOriginalRequest()

Specified by:

getOriginalRequest in interface WriteRequest

Returns:

the WriteRequest which was requested originally, which is not transformed by any IoFilter.

getDestination

public SocketAddress getDestination()

Returns the destination of this write request.

Specified by:

getDestination in interface WriteRequest

Returns:

null for the default destination

toString

public String toString()

Overrides:

toString in class Object

isEncoded

public boolean isEncoded()

Tells if the current message has been encoded

Specified by:

isEncoded in interface WriteRequest

Returns:

true if the message has already been encoded