Module io.helidon.media.common

Package io.helidon.media.common

Class ContentWriters

java.lang.Object

io.helidon.media.common.ContentWriters

public final class ContentWriters
extends Object

Utility class that provides standalone mechanisms for writing message body content.

Method Summary

Modifier and Type	Method	Description
static Function<byte[],Flow.Publisher<DataChunk>>	byteArrayWriter(boolean copy)	Deprecated. since 2.0.0, use writeBytes(byte[], boolean) instead
static Function<ReadableByteChannel,Flow.Publisher<DataChunk>>	byteChannelWriter()	Deprecated. since 2.0.0, use DefaultMediaSupport.byteChannelWriter()} instead
static Function<ReadableByteChannel,Flow.Publisher<DataChunk>>	byteChannelWriter(RetrySchema retrySchema)	Deprecated. since 2.0.0, use DefaultMediaSupport.byteChannelWriter(RetrySchema)} instead
static Function<CharBuffer,Flow.Publisher<DataChunk>>	charBufferWriter(Charset charset)	Deprecated. since 2.0.0, use writeCharBuffer(CharBuffer, Charset) instead
static Function<CharSequence,Flow.Publisher<DataChunk>>	charSequenceWriter(Charset charset)	Deprecated. since 2.0.0, use writeCharSequence(CharSequence, Charset) or DefaultMediaSupport.charSequenceWriter() instead
static Single<DataChunk>	writeBytes(byte[] bytes, boolean copy)	Create a DataChunk with the given byte array and return a Single.
static Single<DataChunk>	writeCharBuffer(CharBuffer buffer, Charset charset)	Create a a publisher DataChunk with the given CharBuffer / Charset and return a Single.
static Single<DataChunk>	writeCharSequence(CharSequence cs, Charset charset)	Create a publisher of DataChunk with the given CharSequence / Charset and return a Single.
static Single<DataChunk>	writeStackTrace(Throwable throwable, Charset charset)	Create a a publisher DataChunk with the given Throwable / Charset and return a Single.

Methods inherited from class java.lang.Object

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

Method Detail

writeBytes

public static Single<DataChunk> writeBytes(byte[] bytes,
                                           boolean copy)

Create a DataChunk with the given byte array and return a Single.

Parameters:

bytes - the byte array

copy - if true the byte array is copied

Returns:

Single

Since:

2.0.0

writeCharSequence

public static Single<DataChunk> writeCharSequence(CharSequence cs,
                                                  Charset charset)

Create a publisher of DataChunk with the given CharSequence / Charset and return a Single.

Parameters:

cs - the char sequence

charset - the charset to use to encode the char sequence

Returns:

Single

Since:

2.0.0

writeCharBuffer

public static Single<DataChunk> writeCharBuffer(CharBuffer buffer,
                                                Charset charset)

Create a a publisher DataChunk with the given CharBuffer / Charset and return a Single.

Parameters:

buffer - the char buffer

charset - the charset to use to encode the char sequence

Returns:

Single

Since:

2.0.0

writeStackTrace

public static Single<DataChunk> writeStackTrace(Throwable throwable,
                                                Charset charset)

Create a a publisher DataChunk with the given Throwable / Charset and return a Single.

Parameters:

throwable - the Throwable

charset - the charset to use to encode the stack trace

Returns:

Single

Since:

2.0.0

byteArrayWriter

@Deprecated(since="2.0.0")
public static Function<byte[],Flow.Publisher<DataChunk>> byteArrayWriter(boolean copy)

Deprecated.

since 2.0.0, use writeBytes(byte[], boolean) instead

Returns a writer function for byte[].

The copy variant is by default registered in ServerResponse.

Parameters:

copy - a signal if byte array should be copied - set it true if byte[] will be immediately reused.

Returns:

a byte[] writer

charSequenceWriter

@Deprecated(since="2.0.0")
public static Function<CharSequence,Flow.Publisher<DataChunk>> charSequenceWriter(Charset charset)

Deprecated.

since 2.0.0, use writeCharSequence(CharSequence, Charset) or DefaultMediaSupport.charSequenceWriter() instead

Returns a writer function for CharSequence using provided standard charset.

An instance is by default registered in ServerResponse for all standard charsets.

Parameters:

charset - a standard charset to use

Returns:

a String writer

Throws:

NullPointerException - if parameter charset is null

charBufferWriter

@Deprecated(since="2.0.0")
public static Function<CharBuffer,Flow.Publisher<DataChunk>> charBufferWriter(Charset charset)

Deprecated.

since 2.0.0, use writeCharBuffer(CharBuffer, Charset) instead

Returns a writer function for CharBuffer using provided standard charset.

An instance is by default registered in ServerResponse for all standard charsets.

Parameters:

charset - a standard charset to use

Returns:

a String writer

Throws:

NullPointerException - if parameter charset is null

byteChannelWriter

@Deprecated(since="2.0.0")
public static Function<ReadableByteChannel,Flow.Publisher<DataChunk>> byteChannelWriter(RetrySchema retrySchema)

Deprecated.

since 2.0.0, use DefaultMediaSupport.byteChannelWriter(RetrySchema)} instead

Returns a writer function for ReadableByteChannel. Created publisher use provided RetrySchema to define delay between unsuccessful read attempts.

Parameters:

retrySchema - a retry schema to use in case when read operation reads 0 bytes

Returns:

a ReadableByteChannel writer

byteChannelWriter

@Deprecated(since="2.0.0")
public static Function<ReadableByteChannel,Flow.Publisher<DataChunk>> byteChannelWriter()

Deprecated.

since 2.0.0, use DefaultMediaSupport.byteChannelWriter()} instead

Returns a writer function for ReadableByteChannel.

Returns:

a ReadableByteChannel writer