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