Class MarshaledResponseBody.FileChannel

java.lang.Object

com.soklet.MarshaledResponseBody.FileChannel

All Implemented Interfaces:

MarshaledResponseBody

Enclosing interface:

MarshaledResponseBody

public static final class MarshaledResponseBody.FileChannel
extends Object
implements MarshaledResponseBody

A finalized response body backed by a FileChannel.

Author:

Mark Allen

Nested Class Summary

Nested classes/interfaces inherited from interface MarshaledResponseBody

MarshaledResponseBody.ByteBuffer, MarshaledResponseBody.Bytes, MarshaledResponseBody.File, MarshaledResponseBody.FileChannel

Modifier and Type	Interface	Description
static final class	MarshaledResponseBody.ByteBuffer	A finalized response body backed by a ByteBuffer.
static final class	MarshaledResponseBody.Bytes	A finalized response body backed by a byte array.
static final class	MarshaledResponseBody.File	A finalized response body backed by a file path.
static final class	MarshaledResponseBody.FileChannel	A finalized response body backed by a FileChannel.

Constructor Summary

Constructors

Constructor	Description
FileChannel(@NonNull FileChannel channel, @NonNull Long offset, @NonNull Long count, @NonNull Boolean closeOnComplete)

Method Summary

Modifier and Type	Method	Description
@NonNull FileChannel	getChannel()	The file channel backing this body.
@NonNull Boolean	getCloseOnComplete()	Whether Soklet should close this caller-supplied channel after the response completes or fails.
@NonNull Long	getCount()	The number of channel bytes to write.
@NonNull Long	getLength()	The number of bytes this body will write.
@NonNull Long	getOffset()	The zero-based channel offset from which response bytes should be written.

Methods inherited from class Object

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

Constructor Details

FileChannel

public FileChannel(@NonNull FileChannel channel,
 @NonNull Long offset,
 @NonNull Long count,
 @NonNull Boolean closeOnComplete)

Method Details

getChannel

public @NonNull FileChannel getChannel()

The file channel backing this body.

Returns:

the file channel

getOffset

public @NonNull Long getOffset()

The zero-based channel offset from which response bytes should be written.

Returns:

the channel offset

getCount

public @NonNull Long getCount()

The number of channel bytes to write.

Returns:

the byte count

getCloseOnComplete

public @NonNull Boolean getCloseOnComplete()

Whether Soklet should close this caller-supplied channel after the response completes or fails.

Returns:

true if Soklet should close the channel

getLength

public @NonNull Long getLength()

Description copied from interface: MarshaledResponseBody

The number of bytes this body will write.

Specified by:

getLength in interface MarshaledResponseBody

Returns:

the body length