Package com.linecorp.armeria.common

Class Scheme

java.lang.Object

com.linecorp.armeria.common.Scheme

All Implemented Interfaces:

Comparable<Scheme>

public final class Scheme
extends Object
implements Comparable<Scheme>

A pair of SerializationFormat and SessionProtocol.

A Scheme is represented and used as the scheme of a URI in the following format:

 SerializationFormat.uriText() + '+' + SessionProtocol.uriText()
 

For example:

• "tbinary+https"
• "tcompact+h2c"
• "none+http"

Method Summary

Modifier and Type	Method	Description
int	compareTo(Scheme o)
boolean	equals(Object obj)
int	hashCode()
static Scheme	of(SerializationFormat serializationFormat, SessionProtocol sessionProtocol)	Returns the Scheme of the specified SerializationFormat and SessionProtocol.
static Scheme	parse(String scheme)	Parses the specified String into a Scheme.
SerializationFormat	serializationFormat()	Returns the SerializationFormat.
SessionProtocol	sessionProtocol()	Returns the SessionProtocol.
String	toString()
static Optional<Scheme>	tryParse(String scheme)	Parses the specified String into a Scheme.
String	uriText()	Returns the textual representation ("serializationFormat+sessionProtocol").

Methods inherited from class java.lang.Object

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

Method Detail

tryParse

public static Optional<Scheme> tryParse(@Nullable
                                        String scheme)

Parses the specified String into a Scheme. This method will return the same Scheme instance for equal values of scheme.

Returns:

Optional.empty() if the specified String could not be parsed or there is no such Scheme available

parse

public static Scheme parse(String scheme)

Parses the specified String into a Scheme. This method will return the same Scheme instance for equal values of scheme.

Throws:

IllegalArgumentException - if the specified String could not be parsed or there is no such Scheme available

of

public static Scheme of(SerializationFormat serializationFormat,
                        SessionProtocol sessionProtocol)

Returns the Scheme of the specified SerializationFormat and SessionProtocol. This method returns the same Scheme instance for the same combination of SerializationFormat and SessionProtocol.

serializationFormat

public SerializationFormat serializationFormat()

Returns the SerializationFormat.

sessionProtocol

public SessionProtocol sessionProtocol()

Returns the SessionProtocol.

uriText

public String uriText()

Returns the textual representation ("serializationFormat+sessionProtocol").

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(Scheme o)

Specified by:

compareTo in interface Comparable<Scheme>

toString

public String toString()

Overrides:

toString in class Object