Package io.micronaut.http.server.codec

Class TextStreamCodec

java.lang.Object

io.micronaut.http.server.codec.TextStreamCodec

All Implemented Interfaces:

MediaTypeCodec

@Singleton
@Internal
@Requires(bean=ByteBufferFactory.class)
@Deprecated(forRemoval=true,
            since="4.7")
public class TextStreamCodec
extends Object
implements MediaTypeCodec

Deprecated, for removal: This API element is subject to removal in a future version.

Replaced with message body writers / readers API

A MediaTypeCodec that will encode Event objects in order to support Server Sent Events.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIGURATION_QUALIFIER	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Modifier	Constructor	Description
	TextStreamCodec(ApplicationConfiguration applicationConfiguration, ByteBufferFactory byteBufferFactory, BeanProvider<MediaTypeCodecRegistry> codecRegistryProvider, @Nullable CodecConfiguration codecConfiguration)	Deprecated, for removal: This API element is subject to removal in a future version.
protected	TextStreamCodec(Charset defaultCharset, ByteBufferFactory byteBufferFactory, BeanProvider<MediaTypeCodecRegistry> codecRegistryProvider, @Nullable CodecConfiguration codecConfiguration)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
<T> T	decode(Argument<T> type, InputStream inputStream)	Deprecated, for removal: This API element is subject to removal in a future version. Decode the given type from the given InputStream.
<T> T	decode(Class<T> type, InputStream inputStream)	Deprecated, for removal: This API element is subject to removal in a future version. Decode the given type from the given InputStream.
<T> byte[]	encode(T object)	Deprecated, for removal: This API element is subject to removal in a future version. Encode the given type returning the object as a byte[].
<T, B> ByteBuffer<B>	encode(T object, ByteBufferFactory<?,B> allocator)	Deprecated, for removal: This API element is subject to removal in a future version. Encode the given type returning the object as a ByteBuffer.
<T> void	encode(T object, OutputStream outputStream)	Deprecated, for removal: This API element is subject to removal in a future version. Encode the given type to the given OutputStream.
Collection<MediaType>	getMediaTypes()	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	writeAttribute(ByteBuffer eventData, byte[] attribute, String value)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.codec.MediaTypeCodec

decode, decode, decode, decode, decode, decode, encode, encode, encode, supportsType

Field Details

CONFIGURATION_QUALIFIER

public static final String CONFIGURATION_QUALIFIER

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

Constructor Details

TextStreamCodec

@Inject
public TextStreamCodec(ApplicationConfiguration applicationConfiguration,
 ByteBufferFactory byteBufferFactory,
 BeanProvider<MediaTypeCodecRegistry> codecRegistryProvider,
 @Named("text-stream") @Nullable
 @Nullable CodecConfiguration codecConfiguration)

Deprecated, for removal: This API element is subject to removal in a future version.

Parameters:

applicationConfiguration - The application configuration

byteBufferFactory - A byte buffer factory

codecRegistryProvider - A media type codec registry

codecConfiguration - The configuration for the codec

TextStreamCodec

protected TextStreamCodec(Charset defaultCharset,
 ByteBufferFactory byteBufferFactory,
 BeanProvider<MediaTypeCodecRegistry> codecRegistryProvider,
 @Named("text-stream") @Nullable
 @Nullable CodecConfiguration codecConfiguration)

Deprecated, for removal: This API element is subject to removal in a future version.

Parameters:

defaultCharset - The default charset

byteBufferFactory - A byte buffer factory

codecRegistryProvider - A media type codec registry

codecConfiguration - The configuration for the codec

Method Details

getMediaTypes

public Collection<MediaType> getMediaTypes()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getMediaTypes in interface MediaTypeCodec

Returns:

The media type of the codec

decode

public <T> T decode(Argument<T> type,
 InputStream inputStream)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: MediaTypeCodec

Decode the given type from the given InputStream.

Specified by:

decode in interface MediaTypeCodec

Type Parameters:

T - The generic type

Parameters:

type - The type

inputStream - The input stream

Returns:

The decoded result

decode

public <T> T decode(Class<T> type,
 InputStream inputStream)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: MediaTypeCodec

Decode the given type from the given InputStream.

Specified by:

decode in interface MediaTypeCodec

Type Parameters:

T - The generic type

Parameters:

type - The type

inputStream - The input stream

Returns:

The decoded result

encode

public <T> void encode(T object,
 OutputStream outputStream)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: MediaTypeCodec

Encode the given type to the given OutputStream.

Specified by:

encode in interface MediaTypeCodec

Type Parameters:

T - The generic type

Parameters:

object - The object to encode

outputStream - The output stream

encode

public <T> byte[] encode(T object)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: MediaTypeCodec

Encode the given type returning the object as a byte[].

Specified by:

encode in interface MediaTypeCodec

Type Parameters:

T - The generic type

Parameters:

object - The object to encode

Returns:

The decoded result

encode

public <T,
B> ByteBuffer<B> encode(T object,
 ByteBufferFactory<?,B> allocator)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: MediaTypeCodec

Encode the given type returning the object as a ByteBuffer.

Specified by:

encode in interface MediaTypeCodec

Type Parameters:

T - The generic type

B - The buffer type

Parameters:

object - The object to encode

allocator - The allocator

Returns:

The decoded result

writeAttribute

protected void writeAttribute(ByteBuffer eventData,
 byte[] attribute,
 String value)

Deprecated, for removal: This API element is subject to removal in a future version.

Parameters:

eventData - The byte buffer

attribute - The attribute

value - The value