Package com.linecorp.armeria.client

Class ClientOption<T>

java.lang.Object

com.linecorp.armeria.common.util.AbstractOption<ClientOption<T>,ClientOptionValue<T>,T>

com.linecorp.armeria.client.ClientOption<T>

Type Parameters:

T - the type of the option value

All Implemented Interfaces:

Comparable<AbstractOption<?,?,?>>

public final class ClientOption<T>
extends AbstractOption<ClientOption<T>,ClientOptionValue<T>,T>

A client option.

Nested Class Summary

Nested classes/interfaces inherited from class com.linecorp.armeria.common.util.AbstractOption

AbstractOption.Factory<T extends AbstractOption<T,U,V>,U extends AbstractOptionValue<U,T,V>,V>

Method Summary

Modifier and Type	Method	Description
static Set<ClientOption<?>>	allOptions()	Returns the all available ClientOptions.
static <T> ClientOption<T>	define(String name, T defaultValue)	Defines a new ClientOption of the specified name and default value.
static <T> ClientOption<T>	define(String name, T defaultValue, Function<T,T> validator, BiFunction<ClientOptionValue<T>,ClientOptionValue<T>,ClientOptionValue<T>> mergeFunction)	Defines a new ClientOption of the specified name, default value and merge function.
protected ClientOptionValue<T>	doNewValue(T value)	Implement this method to return a new option value.
static ClientOption<?>	of(String name)	Returns the ClientOption with the specified name.

Methods inherited from class com.linecorp.armeria.common.util.AbstractOption

allOptions, compareTo, defaultValue, define, equals, hashCode, name, newValue, of, toString

Methods inherited from class java.lang.Object

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

Method Details

allOptions

public static Set<ClientOption<?>> allOptions()

Returns the all available ClientOptions.

of

public static ClientOption<?> of(String name)

Returns the ClientOption with the specified name.

Throws:

NoSuchElementException - if there's no such option defined.

define

public static <T> ClientOption<T> define(String name,
 T defaultValue)

Defines a new ClientOption of the specified name and default value.

Parameters:

name - the name of the option.

defaultValue - the default value of the option, which will be used when unspecified.

Throws:

IllegalStateException - if an option with the specified name exists already.

define

public static <T> ClientOption<T> define(String name,
 T defaultValue,
 Function<T,T> validator,
 BiFunction<ClientOptionValue<T>,ClientOptionValue<T>,ClientOptionValue<T>> mergeFunction)

Defines a new ClientOption of the specified name, default value and merge function.

Parameters:

name - the name of the option.

defaultValue - the default value of the option, which will be used when unspecified.

validator - the Function which is used for validating and normalizing an option value.

mergeFunction - the BiFunction which is used for merging old and new option values.

Throws:

IllegalStateException - if an option with the specified name exists already.

doNewValue

protected ClientOptionValue<T> doNewValue(T value)

Description copied from class: AbstractOption

Implement this method to return a new option value.

Specified by:

doNewValue in class AbstractOption<ClientOption<T>,ClientOptionValue<T>,T>