Package org.apache.bookkeeper.common.conf

Class ConfigKey.ConfigKeyBuilder

java.lang.Object

org.apache.bookkeeper.common.conf.ConfigKey.ConfigKeyBuilder

Enclosing class:

ConfigKey

public static class ConfigKey.ConfigKeyBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
ConfigKeyBuilder()

Method Summary

Modifier and Type	Method	Description
ConfigKey	build()
ConfigKey.ConfigKeyBuilder	defaultValue(Object defaultValue)	Default value as a string representation.
ConfigKey.ConfigKeyBuilder	dependents(List<String> dependents)	The list of settings dependents on this setting.
ConfigKey.ConfigKeyBuilder	deprecated(boolean deprecated)	Whether this setting is deprecated or not.
ConfigKey.ConfigKeyBuilder	deprecatedByConfigKey(String deprecatedByConfigKey)	The config key that deprecates this key.
ConfigKey.ConfigKeyBuilder	deprecatedSince(String deprecatedSince)	The version when this settings was deprecated.
ConfigKey.ConfigKeyBuilder	description(String description)	Description of the configuration setting.
ConfigKey.ConfigKeyBuilder	documentation(String documentation)	Documentation of the configuration setting.
ConfigKey.ConfigKeyBuilder	group(ConfigKeyGroup group)	The key-group to group settings together.
ConfigKey.ConfigKeyBuilder	name(String name)	Name of the configuration setting.
ConfigKey.ConfigKeyBuilder	optionValues(List<String> optionValues)	The list of options for this setting.
ConfigKey.ConfigKeyBuilder	orderInGroup(int orderInGroup)	The order of the setting in the key-group.
ConfigKey.ConfigKeyBuilder	required(boolean required)	Flag indicates whether the setting is required.
ConfigKey.ConfigKeyBuilder	since(String since)	The version when this setting was introduced.
String	toString()
ConfigKey.ConfigKeyBuilder	type(Type type)	Type of the configuration setting.
ConfigKey.ConfigKeyBuilder	validator(Validator validator)	The validator used for validating configuration value.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigKeyBuilder

ConfigKeyBuilder()

Method Details

required

public ConfigKey.ConfigKeyBuilder required(boolean required)

Flag indicates whether the setting is required.

Returns:

this.

name

public ConfigKey.ConfigKeyBuilder name(String name)

Name of the configuration setting.

Returns:

this.

type

public ConfigKey.ConfigKeyBuilder type(Type type)

Type of the configuration setting.

Returns:

this.

description

public ConfigKey.ConfigKeyBuilder description(String description)

Description of the configuration setting.

Returns:

this.

documentation

public ConfigKey.ConfigKeyBuilder documentation(String documentation)

Documentation of the configuration setting.

Returns:

this.

defaultValue

public ConfigKey.ConfigKeyBuilder defaultValue(Object defaultValue)

Default value as a string representation.

Returns:

this.

optionValues

public ConfigKey.ConfigKeyBuilder optionValues(List<String> optionValues)

The list of options for this setting.

Returns:

this.

validator

public ConfigKey.ConfigKeyBuilder validator(Validator validator)

The validator used for validating configuration value.

Returns:

this.

group

public ConfigKey.ConfigKeyBuilder group(ConfigKeyGroup group)

The key-group to group settings together.

Returns:

this.

orderInGroup

public ConfigKey.ConfigKeyBuilder orderInGroup(int orderInGroup)

The order of the setting in the key-group.

Returns:

this.

dependents

public ConfigKey.ConfigKeyBuilder dependents(List<String> dependents)

The list of settings dependents on this setting.

Returns:

this.

deprecated

public ConfigKey.ConfigKeyBuilder deprecated(boolean deprecated)

Whether this setting is deprecated or not.

Returns:

this.

deprecatedByConfigKey

public ConfigKey.ConfigKeyBuilder deprecatedByConfigKey(String deprecatedByConfigKey)

The config key that deprecates this key.

Returns:

this.

deprecatedSince

public ConfigKey.ConfigKeyBuilder deprecatedSince(String deprecatedSince)

The version when this settings was deprecated.

Returns:

this.

since

public ConfigKey.ConfigKeyBuilder since(String since)

The version when this setting was introduced.

Returns:

this.

build

public ConfigKey build()

toString

public String toString()

Overrides:

toString in class Object