Package org.keycloak.config

Class OptionBuilder<T>

java.lang.Object

org.keycloak.config.OptionBuilder<T>

public class OptionBuilder<T>
extends Object

Constructor Summary

Constructors

Constructor	Description
OptionBuilder(String key, Class<T> type)

Method Summary

Modifier and Type	Method	Description
Option<T>	build()
OptionBuilder<T>	buildTime(boolean build)
OptionBuilder<T>	category(OptionCategory category)
OptionBuilder<T>	defaultValue(Optional<T> defaultV)
OptionBuilder<T>	defaultValue(T defaultV)
OptionBuilder<T>	deprecated()
OptionBuilder<T>	deprecated(String note)
OptionBuilder<T>	deprecated(String note, Set<String> newOptionsKeys)
OptionBuilder<T>	deprecated(Set<String> newOptionsKeys)
OptionBuilder<T>	deprecatedValues(Set<String> values, String note)
OptionBuilder<T>	description(String description)
OptionBuilder<T>	expectedValues(boolean strict, Class<? extends Enum> expected)
OptionBuilder<T>	expectedValues(boolean strict, List<String> expected)
OptionBuilder<T>	expectedValues(boolean strict, T... expected)
OptionBuilder<T>	expectedValues(Class<? extends Enum> expected)
OptionBuilder<T>	expectedValues(List<String> expected)
OptionBuilder<T>	expectedValues(T... expected)
OptionBuilder<T>	hidden()
static <A> OptionBuilder<List<A>>	listOptionBuilder(String key, Class<A> type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OptionBuilder

public OptionBuilder(String key,
 Class<T> type)

Method Details

listOptionBuilder

public static <A> OptionBuilder<List<A>> listOptionBuilder(String key,
 Class<A> type)

category

public OptionBuilder<T> category(OptionCategory category)

hidden

public OptionBuilder<T> hidden()

buildTime

public OptionBuilder<T> buildTime(boolean build)

description

public OptionBuilder<T> description(String description)

defaultValue

public OptionBuilder<T> defaultValue(Optional<T> defaultV)

defaultValue

public OptionBuilder<T> defaultValue(T defaultV)

expectedValues

public OptionBuilder<T> expectedValues(List<String> expected)

expectedValues

public OptionBuilder<T> expectedValues(boolean strict,
 List<String> expected)

Parameters:

strict - if only expected values are allowed, or some other custom value can be specified

expected - expected values

expectedValues

public OptionBuilder<T> expectedValues(Class<? extends Enum> expected)

expectedValues

public OptionBuilder<T> expectedValues(boolean strict,
 Class<? extends Enum> expected)

expectedValues

public OptionBuilder<T> expectedValues(T... expected)

expectedValues

public OptionBuilder<T> expectedValues(boolean strict,
 T... expected)

Parameters:

strict - if only expected values are allowed, or some other custom value can be specified

expected - expected values - if empty and the type or auxiliaryType is enum, values are inferred

deprecated

public OptionBuilder<T> deprecated()

deprecated

public OptionBuilder<T> deprecated(String note)

deprecated

public OptionBuilder<T> deprecated(Set<String> newOptionsKeys)

deprecated

public OptionBuilder<T> deprecated(String note,
 Set<String> newOptionsKeys)

deprecatedValues

public OptionBuilder<T> deprecatedValues(Set<String> values,
 String note)

build

public Option<T> build()