com.github.jcustenborder.kafka.connect.utils.templates

Class ImmutableConfiguration.Builder

java.lang.Object

com.github.jcustenborder.kafka.connect.utils.templates.ImmutableConfiguration.Builder

Enclosing class:

ImmutableConfiguration

@NotThreadSafe
public static final class ImmutableConfiguration.Builder
extends Object

Builds instances of type ImmutableConfiguration. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
ImmutableConfiguration.Builder	addAllGroups(Iterable<? extends Plugin.Group> elements) Adds elements to groups list.
ImmutableConfiguration.Builder	addAllRequiredConfigs(Iterable<? extends Plugin.Item> elements) Adds elements to requiredConfigs list.
ImmutableConfiguration.Builder	addGroups(Plugin.Group... elements) Adds elements to groups list.
ImmutableConfiguration.Builder	addGroups(Plugin.Group element) Adds one element to groups list.
ImmutableConfiguration.Builder	addRequiredConfigs(Plugin.Item... elements) Adds elements to requiredConfigs list.
ImmutableConfiguration.Builder	addRequiredConfigs(Plugin.Item element) Adds one element to requiredConfigs list.
ImmutableConfiguration	build() Builds a new ImmutableConfiguration.
ImmutableConfiguration.Builder	configDef(org.apache.kafka.common.config.ConfigDef configDef) Initializes the value for the configDef attribute.
ImmutableConfiguration.Builder	from(Plugin.Configuration instance) Fill a builder with attribute values from the provided Configuration instance.
ImmutableConfiguration.Builder	groups(Iterable<? extends Plugin.Group> elements) Sets or replaces all elements for groups list.
ImmutableConfiguration.Builder	requiredConfigs(Iterable<? extends Plugin.Item> elements) Sets or replaces all elements for requiredConfigs list.

Methods inherited from class java.lang.Object

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

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableConfiguration.Builder from(Plugin.Configuration instance)

Fill a builder with attribute values from the provided Configuration instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

configDef

@CanIgnoreReturnValue
public final ImmutableConfiguration.Builder configDef(org.apache.kafka.common.config.ConfigDef configDef)

Initializes the value for the configDef attribute.

Parameters:

configDef - The value for configDef

Returns:

this builder for use in a chained invocation

addGroups

@CanIgnoreReturnValue
public final ImmutableConfiguration.Builder addGroups(Plugin.Group element)

Adds one element to groups list.

Parameters:

element - A groups element

Returns:

this builder for use in a chained invocation

addGroups

@CanIgnoreReturnValue
public final ImmutableConfiguration.Builder addGroups(Plugin.Group... elements)

Adds elements to groups list.

Parameters:

elements - An array of groups elements

Returns:

this builder for use in a chained invocation

groups

@CanIgnoreReturnValue
public final ImmutableConfiguration.Builder groups(Iterable<? extends Plugin.Group> elements)

Sets or replaces all elements for groups list.

Parameters:

elements - An iterable of groups elements

Returns:

this builder for use in a chained invocation

addAllGroups

@CanIgnoreReturnValue
public final ImmutableConfiguration.Builder addAllGroups(Iterable<? extends Plugin.Group> elements)

Adds elements to groups list.

Parameters:

elements - An iterable of groups elements

Returns:

this builder for use in a chained invocation

addRequiredConfigs

@CanIgnoreReturnValue
public final ImmutableConfiguration.Builder addRequiredConfigs(Plugin.Item element)

Adds one element to requiredConfigs list.

Parameters:

element - A requiredConfigs element

Returns:

this builder for use in a chained invocation

addRequiredConfigs

@CanIgnoreReturnValue
public final ImmutableConfiguration.Builder addRequiredConfigs(Plugin.Item... elements)

Adds elements to requiredConfigs list.

Parameters:

elements - An array of requiredConfigs elements

Returns:

this builder for use in a chained invocation

requiredConfigs

@CanIgnoreReturnValue
public final ImmutableConfiguration.Builder requiredConfigs(Iterable<? extends Plugin.Item> elements)

Sets or replaces all elements for requiredConfigs list.

Parameters:

elements - An iterable of requiredConfigs elements

Returns:

this builder for use in a chained invocation

addAllRequiredConfigs

@CanIgnoreReturnValue
public final ImmutableConfiguration.Builder addAllRequiredConfigs(Iterable<? extends Plugin.Item> elements)

Adds elements to requiredConfigs list.

Parameters:

elements - An iterable of requiredConfigs elements

Returns:

this builder for use in a chained invocation

build

public ImmutableConfiguration build()

Builds a new ImmutableConfiguration.

Returns:

An immutable instance of Configuration

Throws:

IllegalStateException - if any required attributes are missing