Module io.netty5.handler

Package io.netty5.handler.adaptor

Enum BufferConversionHandler.Conversion

java.lang.Object

java.lang.Enum<BufferConversionHandler.Conversion>

io.netty5.handler.adaptor.BufferConversionHandler.Conversion

All Implemented Interfaces:

Serializable, Comparable<BufferConversionHandler.Conversion>

Enclosing class:

BufferConversionHandler

public static enum BufferConversionHandler.Conversion
extends Enum<BufferConversionHandler.Conversion>

The particular conversion operation to apply. See the individual operations for their specific behaviour.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH	Convert any Buffers into ByteBufs, and any ByteBufs into Buffers.
BUFFER_TO_BYTEBUF	Convert Buffer instances to ByteBuf instances.
BYTEBUF_TO_BUFFER	Convert ByteBuf instances to Buffer instances.
NONE	Do not convert anything, but let the messages pass through unchanged.

Method Summary

Modifier and Type	Method	Description
abstract Object	convert(Object msg)	Apply this conversion to the given message, if applicable.
abstract BufferConversionHandler.Conversion	invert()	Return a BufferConversionHandler.Conversion that is the inverse of this one.
static BufferConversionHandler.Conversion	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BufferConversionHandler.Conversion[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BYTEBUF_TO_BUFFER

public static final BufferConversionHandler.Conversion BYTEBUF_TO_BUFFER

Convert ByteBuf instances to Buffer instances.

Messages that are either already of a Buffer type, or of an unknown type, will pass through unchanged.

BUFFER_TO_BYTEBUF

public static final BufferConversionHandler.Conversion BUFFER_TO_BYTEBUF

Convert Buffer instances to ByteBuf instances.

Messages that are either already of a ByteBuf type, or of an unknown type, will pass through unchanged.

BOTH

public static final BufferConversionHandler.Conversion BOTH

Convert any Buffers into ByteBufs, and any ByteBufs into Buffers.

Messages of unknown types are passed through unchanged.

NONE

public static final BufferConversionHandler.Conversion NONE

Do not convert anything, but let the messages pass through unchanged.

Method Detail

values

public static BufferConversionHandler.Conversion[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BufferConversionHandler.Conversion c : BufferConversionHandler.Conversion.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BufferConversionHandler.Conversion valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

convert

public abstract Object convert(Object msg)

Apply this conversion to the given message, if applicable.

Parameters:

msg - The message to maybe be converted.

Returns:

The result of the conversion.

invert

public abstract BufferConversionHandler.Conversion invert()

Return a BufferConversionHandler.Conversion that is the inverse of this one.

Returns:

A conversion that converts buffers in the opposite direction.