Module io.aiven.commons.kafka.config

Package io.aiven.commons.kafka.config

Class ExtendedConfigKey.Builder<T extends ExtendedConfigKey.Builder<?>>

java.lang.Object

io.aiven.commons.kafka.config.ConfigKeyBuilder<T>

io.aiven.commons.kafka.config.ExtendedConfigKey.Builder<T>

Type Parameters:

T - the type of the file ConfigKey instance.

Enclosing class:

ExtendedConfigKey

public static class ExtendedConfigKey.Builder<T extends ExtendedConfigKey.Builder<?>>
extends ConfigKeyBuilder<T>

The builder for an ExtendedConfigKey.

Field Summary

Fields inherited from class io.aiven.commons.kafka.config.ConfigKeyBuilder

defaultValue, dependents, displayName, documentation, group, importance, internalConfig, name, orderInGroup, recommender, type, validator, width

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(String name)	The builder.

Method Summary

Modifier and Type	Method	Description
ExtendedConfigKey	build()	Builds a ConfigKey from the specified values.
final T	deprecatedInfo(DeprecatedInfo deprecatedInfo)	Sets the deprecation info.
final T	deprecatedInfo(DeprecatedInfo.Builder deprecatedInfoBuilder)	Sets the deprecation info.
protected String	generateDocumentation()	Generates the documentation.
final T	since(SinceInfo since)	Sets the since value.
static <T extends ExtendedConfigKey.Builder<?>> ExtendedConfigKey.Builder<T>	unbuild(org.apache.kafka.common.config.ConfigDef.ConfigKey key)	unbuilds a key.

Methods inherited from class io.aiven.commons.kafka.config.ConfigKeyBuilder

defaultValue, dependent, dependents, dependents, displayName, documentation, group, importance, internalConfig, orderInGroup, recommender, self, type, validator, width

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder(String name)

The builder.

Parameters:

name - the name of the final ConfigKey

Method Details

unbuild

public static <T extends ExtendedConfigKey.Builder<?>>
ExtendedConfigKey.Builder<T> unbuild(org.apache.kafka.common.config.ConfigDef.ConfigKey key)

unbuilds a key. Creates an ExtendedConfigKey.Builder from the key.

Type Parameters:

T - the type of the builder.

Parameters:

key - the key to unbuild.

Returns:

An extended key builder

build

public ExtendedConfigKey build()

Description copied from class: ConfigKeyBuilder

Builds a ConfigKey from the specified values.

Overrides:

build in class ConfigKeyBuilder<T extends ExtendedConfigKey.Builder<?>>

Returns:

a ConfigKey from the specified values.

generateDocumentation

protected String generateDocumentation()

Description copied from class: ConfigKeyBuilder

Generates the documentation. This is an extension point for ConfigKey builders to modify the documentation. For example adding deprecation information, or interactions with other keys in the configuration.

Overrides:

generateDocumentation in class ConfigKeyBuilder<T extends ExtendedConfigKey.Builder<?>>

Returns:

the documentation for the component.

deprecatedInfo

public final T deprecatedInfo(DeprecatedInfo.Builder deprecatedInfoBuilder)

Sets the deprecation info.

Parameters:

deprecatedInfoBuilder - the builder for the DeprecatedInfo

Returns:

this

deprecatedInfo

public final T deprecatedInfo(DeprecatedInfo deprecatedInfo)

Sets the deprecation info.

Parameters:

deprecatedInfo - the Deprecated info to use.

Returns:

this

since

public final T since(SinceInfo since)

Sets the since value.

Parameters:

since - the since value.

Returns:

this.