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 final SerializationFormat	NONE	No serialization format.
static final SerializationFormat	UNKNOWN	Unknown serialization format.
static final SerializationFormat	WS	Serialization format for WebSocket.

Method Summary

Modifier and Type	Method	Description
int	compareTo(SerializationFormat o)
boolean	equals(@Nullable Object obj)
static @Nullable SerializationFormat	find(MediaType... ranges)	Finds the SerializationFormat which is accepted by any of the specified media ranges.
static @Nullable SerializationFormat	find(String uriText)	Finds the SerializationFormat with the specified uriText().
int	hashCode()
boolean	isAccepted(MediaType range)	Returns whether the specified media range is accepted by any of the mediaTypes() defined by this format.
boolean	isAccepted(MediaType first, MediaType... rest)	Returns whether any of the specified media ranges is accepted by any of the mediaTypes() defined by this format.
boolean	isAccepted(Iterable<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().
boolean	requiresNewConnection(SessionProtocol protocol)	Returns whether this SessionProtocol needs to establish a new connection instead of acquiring it from the connection pool.
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 Details

NONE

public static final SerializationFormat NONE

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

WS

@UnstableApi
public static final SerializationFormat WS

Serialization format for WebSocket.

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.

Method Details

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

@Nullable
public static @Nullable SerializationFormat find(String uriText)

Finds the SerializationFormat with the specified uriText().

find

@Nullable
public static @Nullable SerializationFormat find(MediaType... ranges)

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

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.

requiresNewConnection

public boolean requiresNewConnection(SessionProtocol protocol)

Returns whether this SessionProtocol needs to establish a new connection instead of acquiring it from the connection pool.

isAccepted

public boolean isAccepted(MediaType range)

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

isAccepted

public boolean isAccepted(MediaType first,
 MediaType... rest)

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

isAccepted

public boolean isAccepted(Iterable<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(@Nullable
 @Nullable 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