Package com.linecorp.armeria.common

Class SerializationFormat

java.lang.Object

com.linecorp.armeria.common.SerializationFormat

All Implemented Interfaces:

Comparable<SerializationFormat>

public final class SerializationFormat
extends Object
implements Comparable<SerializationFormat>

Serialization format of a remote procedure call and its reply.

Field Summary

Fields

Modifier and Type	Field	Description
static SerializationFormat	NONE	No serialization format.
static SerializationFormat	THRIFT_BINARY	Deprecated. Use ThriftSerializationFormats.BINARY.
static SerializationFormat	THRIFT_COMPACT	Deprecated. Use ThriftSerializationFormats.COMPACT.
static SerializationFormat	THRIFT_JSON	Deprecated. Use ThriftSerializationFormats.JSON.
static SerializationFormat	THRIFT_TEXT	Deprecated. Use ThriftSerializationFormats.TEXT.
static SerializationFormat	UNKNOWN	Unknown serialization format.

Method Summary

Modifier and Type	Method	Description
int	compareTo(SerializationFormat o)
boolean	equals(Object obj)
static Optional<SerializationFormat>	find(MediaType... ranges)	Finds the SerializationFormat which is accepted by any of the specified media ranges.
static Optional<SerializationFormat>	find(String uriText)	Finds the SerializationFormat with the specified uriText().
static Optional<SerializationFormat>	fromMediaType(String mediaType)	Deprecated. Use find(MediaType...).
int	hashCode()
boolean	isAccepted(MediaType... ranges)	Returns whether any of the specified media ranges is accepted by any of the mediaTypes() defined by this format.
MediaType	mediaType()	Returns the primary MediaType of this format.
MediaTypeSet	mediaTypes()	Returns the media types accepted by this format.
static SerializationFormat	of(String uriText)	Returns the SerializationFormat with the specified uriText().
static Set<SerializationFormat>	ofThrift()	Deprecated. Use ThriftSerializationFormats.values().
String	toString()
String	uriText()	Returns the textual representation of this format for use in a Scheme.
static Set<SerializationFormat>	values()	Returns all available SerializationFormats.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field 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 or recognize it.

THRIFT_BINARY

@Nullable
@Deprecated
public static final SerializationFormat THRIFT_BINARY

Deprecated.

Use ThriftSerializationFormats.BINARY. Note that the value of this field will be null if armeria-thrift module is not loaded.

Thrift TBinary serialization format.

THRIFT_COMPACT

@Nullable
@Deprecated
public static final SerializationFormat THRIFT_COMPACT

Deprecated.

Use ThriftSerializationFormats.COMPACT. Note that the value of this field will be null if armeria-thrift module is not loaded.

Thrift TCompact serialization format.

THRIFT_JSON

@Nullable
@Deprecated
public static final SerializationFormat THRIFT_JSON

Deprecated.

Use ThriftSerializationFormats.JSON. Note that the value of this field will be null if armeria-thrift module is not loaded.

Thrift TJSON serialization format.

THRIFT_TEXT

@Nullable
@Deprecated
public static final SerializationFormat THRIFT_TEXT

Deprecated.

Use ThriftSerializationFormats.TEXT. Note that the value of this field will be null if armeria-thrift module is not loaded.

Thrift TText serialization format.

Method Detail

ofThrift

@Deprecated
public static Set<SerializationFormat> ofThrift()

Deprecated.

Use ThriftSerializationFormats.values().

Returns the set of all known Thrift serialization formats.

Throws:

IllegalStateException - if armeria-thrift module is not loaded

values

public static Set<SerializationFormat> values()

Returns all available SerializationFormats.

of

public static SerializationFormat of(String uriText)

Returns the SerializationFormat with the specified uriText().

Throws:

IllegalArgumentException - if there's no such SerializationFormat

find

public static Optional<SerializationFormat> find(String uriText)

Finds the SerializationFormat with the specified uriText().

find

public static Optional<SerializationFormat> find(MediaType... ranges)

Finds the SerializationFormat which is accepted by any of the specified media ranges.

fromMediaType

@Deprecated
public static Optional<SerializationFormat> fromMediaType(@Nullable
                                                          String mediaType)

Deprecated.

Use find(MediaType...).

Finds the SerializationFormat which is accepted by the specified media range.

uriText

public String uriText()

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

mediaType

public MediaType mediaType()

Returns the primary MediaType of this format.

mediaTypes

public MediaTypeSet mediaTypes()

Returns the media types accepted by this format.

isAccepted

public boolean isAccepted(MediaType... ranges)

Returns whether any of the specified media ranges is accepted by any of the mediaTypes() defined by this format.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(SerializationFormat o)

Specified by:

compareTo in interface Comparable<SerializationFormat>

toString

public String toString()

Overrides:

toString in class Object