Module io.helidon.media.common

Package io.helidon.media.common

Class MessageBodyWriteableContent

java.lang.Object

io.helidon.media.common.MessageBodyWriteableContent

All Implemented Interfaces:

MessageBodyContent, MessageBodyFilters, MessageBodyWriters, Flow.Publisher<DataChunk>

public final class MessageBodyWriteableContent
extends Object
implements MessageBodyContent, MessageBodyWriters, MessageBodyFilters

Implementation of WriteableContent.

Method Summary

Modifier and Type	Method	Description
static MessageBodyWriteableContent	create(Object entity, Parameters headers)	Create a new writeable content backed by an entity object.
static MessageBodyWriteableContent	create(Flow.Publisher<DataChunk> publisher, Parameters headers)	Create a new writeable content backed by a raw publisher.
static MessageBodyWriteableContent	create(Flow.Publisher<Object> stream, GenericType<? extends Object> type, Parameters headers)	Create a new writeable content backed by an entity stream.
MessageBodyWriteableContent	registerFilter(MessageBodyFilter filter)	Register a message body filter.
void	registerFilter(Function<Flow.Publisher<DataChunk>,Flow.Publisher<DataChunk>> function)	Deprecated. use registerFilter(MessageBodyFilter) instead
MessageBodyWriteableContent	registerWriter(MessageBodyStreamWriter<?> writer)	Register a stream writer.
MessageBodyWriteableContent	registerWriter(MessageBodyWriter<?> writer)	Register a writer.
<T> MessageBodyWriteableContent	registerWriter(Class<T> type, MediaType contentType, Function<? extends T,Flow.Publisher<DataChunk>> function)	Deprecated. use registerWriter(MessageBodyWriter) instead
<T> MessageBodyWriteableContent	registerWriter(Class<T> type, Function<T,Flow.Publisher<DataChunk>> function)	Deprecated. use registerWriter(MessageBodyWriter) instead
<T> MessageBodyWriteableContent	registerWriter(Predicate<?> accept, MediaType contentType, Function<T,Flow.Publisher<DataChunk>> function)	Deprecated. use registerWriter(MessageBodyWriter) instead
<T> MessageBodyWriteableContent	registerWriter(Predicate<?> accept, Function<T,Flow.Publisher<DataChunk>> function)	Deprecated. use registerWriter(MessageBodyWriter) instead
void	subscribe(Flow.Subscriber<? super DataChunk> subscriber)
Flow.Publisher<DataChunk>	toPublisher(MessageBodyWriterContext fallback)	Convert this writeable content to a raw publisher.
MessageBodyWriterContext	writerContext()	Get the writer context used to marshall data.

Methods inherited from class java.lang.Object

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

Method Detail

writerContext

public MessageBodyWriterContext writerContext()

Get the writer context used to marshall data.

Returns:

MessageBodyWriterContext

subscribe

public void subscribe(Flow.Subscriber<? super DataChunk> subscriber)

Specified by:

subscribe in interface Flow.Publisher<DataChunk>

toPublisher

public Flow.Publisher<DataChunk> toPublisher(MessageBodyWriterContext fallback)

Convert this writeable content to a raw publisher.

Parameters:

fallback - fallback context to use, may be null

Returns:

publisher, never null

registerFilter

public MessageBodyWriteableContent registerFilter(MessageBodyFilter filter)

Description copied from interface: MessageBodyFilters

Register a message body filter.

Specified by:

registerFilter in interface MessageBodyFilters

Parameters:

filter - message body filter to register

Returns:

MessageBodyFilters

registerWriter

public MessageBodyWriteableContent registerWriter(MessageBodyWriter<?> writer)

Description copied from interface: MessageBodyWriters

Register a writer.

Specified by:

registerWriter in interface MessageBodyWriters

Parameters:

writer - writer to register

Returns:

Writers

registerWriter

public MessageBodyWriteableContent registerWriter(MessageBodyStreamWriter<?> writer)

Description copied from interface: MessageBodyWriters

Register a stream writer.

Specified by:

registerWriter in interface MessageBodyWriters

Parameters:

writer - writer to register

Returns:

Writers

registerWriter

@Deprecated
public <T> MessageBodyWriteableContent registerWriter(Class<T> type,
                                                      Function<T,Flow.Publisher<DataChunk>> function)

Deprecated.

use registerWriter(MessageBodyWriter) instead

Registers a writer function with a given type.

Type Parameters:

T - entity type

Parameters:

type - class representing the type supported by this writer

function - writer function

Returns:

this MessageBodyWriteableContent instance

registerWriter

@Deprecated
public <T> MessageBodyWriteableContent registerWriter(Class<T> type,
                                                      MediaType contentType,
                                                      Function<? extends T,Flow.Publisher<DataChunk>> function)

Deprecated.

use registerWriter(MessageBodyWriter) instead

Registers a writer function with a given type and media type.

Type Parameters:

T - entity type

Parameters:

type - class representing the type supported by this writer

contentType - the media type

function - writer function

Returns:

this MessageBodyWriteableContent instance

registerWriter

@Deprecated
public <T> MessageBodyWriteableContent registerWriter(Predicate<?> accept,
                                                      Function<T,Flow.Publisher<DataChunk>> function)

Deprecated.

use registerWriter(MessageBodyWriter) instead

Registers a writer function with a given predicate.

Type Parameters:

T - entity type

Parameters:

accept - the object predicate

function - writer function

Returns:

this MessageBodyWriteableContent instance

registerWriter

@Deprecated
public <T> MessageBodyWriteableContent registerWriter(Predicate<?> accept,
                                                      MediaType contentType,
                                                      Function<T,Flow.Publisher<DataChunk>> function)

Deprecated.

use registerWriter(MessageBodyWriter) instead

Registers a writer function with a given predicate and media type.

Type Parameters:

T - entity type

Parameters:

accept - the object predicate

contentType - the media type

function - writer function

Returns:

this MessageBodyWriteableContent instance

registerFilter

@Deprecated
public void registerFilter(Function<Flow.Publisher<DataChunk>,Flow.Publisher<DataChunk>> function)

Deprecated.

use registerFilter(MessageBodyFilter) instead

Register a filter function.

Parameters:

function - filter function

create

public static MessageBodyWriteableContent create(Object entity,
                                                 Parameters headers)

Create a new writeable content backed by an entity object.

Parameters:

entity - object, must not be null

headers - writer context backing headers, must not be null

Returns:

MessageBodyWriteableContent

create

public static MessageBodyWriteableContent create(Flow.Publisher<Object> stream,
                                                 GenericType<? extends Object> type,
                                                 Parameters headers)

Create a new writeable content backed by an entity stream.

Parameters:

stream - entity stream, must not be null

type - actual type representation, must not be null

headers - writer context backing headers, must not be null

Returns:

MessageBodyWriteableContent

create

public static MessageBodyWriteableContent create(Flow.Publisher<DataChunk> publisher,
                                                 Parameters headers)

Create a new writeable content backed by a raw publisher.

Parameters:

publisher - raw publisher

headers - writer context backing headers, must not be null

Returns:

MessageBodyWriteableContent