Class ByteArrayInstanceWriter

java.lang.Object

io.helidon.http.media.ByteArrayInstanceWriter

All Implemented Interfaces:

InstanceWriter

public final class ByteArrayInstanceWriter
extends Object
implements InstanceWriter

InstanceWriter for bytes already materialized in memory.

Method Summary

Modifier and Type	Method	Description
boolean	alwaysInMemory()	Whether the byte array is always available.
OptionalLong	contentLength()	If we can determine the number of bytes to be written to the stream, provide the information here.
static ByteArrayInstanceWriter	create(byte[] instanceBytes)	Create a new instance writer for bytes already materialized in memory.
byte[]	instanceBytes()	Get the instance as byte array.
void	write(OutputStream stream)	Write the instance to the output stream.

Methods inherited from class Object

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

Method Details

create

public static ByteArrayInstanceWriter create(byte[] instanceBytes)

Create a new instance writer for bytes already materialized in memory.

Parameters:

instanceBytes - bytes to write

Returns:

byte array instance writer

contentLength

public OptionalLong contentLength()

Description copied from interface: InstanceWriter

If we can determine the number of bytes to be written to the stream, provide the information here. The returned number must be a valid content length (content-length >= 0)

Specified by:

contentLength in interface InstanceWriter

Returns:

number of bytes or empty if not possible (or too expensive) to find out

alwaysInMemory

public boolean alwaysInMemory()

Description copied from interface: InstanceWriter

Whether the byte array is always available. If true InstanceWriter.instanceBytes() will ALWAYS be called.

Specified by:

alwaysInMemory in interface InstanceWriter

Returns:

whether the bytes will always be materialized in memory

write

public void write(OutputStream stream)

Description copied from interface: InstanceWriter

Write the instance to the output stream. This method is NEVER called if InstanceWriter.alwaysInMemory() is true, otherwise this method is ALWAYS called if InstanceWriter.contentLength() returns empty. This method MAY be called if InstanceWriter.contentLength() returns a value.

Specified by:

write in interface InstanceWriter

Parameters:

stream - to write to

instanceBytes

public byte[] instanceBytes()

Description copied from interface: InstanceWriter

Get the instance as byte array. This method is always called if InstanceWriter.alwaysInMemory() returns true. This method is NEVER called if InstanceWriter.contentLength() returns empty. This method MAY be called if InstanceWriter.contentLength() returns a value.

Specified by:

instanceBytes in interface InstanceWriter

Returns:

bytes of the instance