com.linecorp.armeria.common

Enum SerializationFormat

java.lang.Object

java.lang.Enum<SerializationFormat>

com.linecorp.armeria.common.SerializationFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SerializationFormat>

public enum SerializationFormat
extends java.lang.Enum<SerializationFormat>

Serialization format of a remote procedure call and its reply.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE No serialization format.
THRIFT_BINARY Thrift TBinary serialization format.
THRIFT_COMPACT Thrift TCompact serialization format.
THRIFT_JSON Thrift TJSON serialization format.
THRIFT_TEXT Thrift TText serialization format.
UNKNOWN Unknown serialization format.

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<SerializationFormat>	fromMediaType(java.lang.String mediaType) Returns the serialization format corresponding to the passed in mediaType, or Optional.empty() if the media type is not recognized.
com.google.common.net.MediaType	mediaType() Returns the MediaType of this format.
static java.util.Set<SerializationFormat>	ofThrift() Returns the set of all known Thrift serialization formats.
java.lang.String	uriText() Returns the textual representation of this format for use in a Scheme.
static SerializationFormat	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SerializationFormat[]	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

NONE

public static final SerializationFormat NONE

No serialization format. Used when no serialization/deserialization is desired.

UNKNOWN

public static final SerializationFormat UNKNOWN

Unknown serialization format. Used when some serialization format is desired but the server failed to understand/recognize it.

THRIFT_BINARY

public static final SerializationFormat THRIFT_BINARY

Thrift TBinary serialization format.

THRIFT_COMPACT

public static final SerializationFormat THRIFT_COMPACT

Thrift TCompact serialization format.

THRIFT_JSON

public static final SerializationFormat THRIFT_JSON

Thrift TJSON serialization format.

THRIFT_TEXT

public static final SerializationFormat THRIFT_TEXT

Thrift TText serialization format. This format is not optimized for performance or backwards compatibility and should only be used in non-production use cases like debugging.

Method Detail

values

public static SerializationFormat[] 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 (SerializationFormat c : SerializationFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static SerializationFormat valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

ofThrift

public static java.util.Set<SerializationFormat> ofThrift()

Returns the set of all known Thrift serialization formats. This method is useful when determining if a SerializationFormat is Thrift or not. e.g. if (SerializationFormat.ofThrift().contains(serFmt)) { ... }

fromMediaType

public static java.util.Optional<SerializationFormat> fromMediaType(@Nullable
                                                                    java.lang.String mediaType)

Returns the serialization format corresponding to the passed in mediaType, or Optional.empty() if the media type is not recognized. null is treated as an unknown mimetype.

uriText

public java.lang.String uriText()

Returns the textual representation of this format for use in a Scheme.

mediaType

public com.google.common.net.MediaType mediaType()

Returns the MediaType of this format.