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

Class ImmutableItem.Builder

java.lang.Object

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

Enclosing class:

ImmutableItem

@NotThreadSafe
public static final class ImmutableItem.Builder
extends Object

Builds instances of type ImmutableItem. 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
ImmutableItem	build() Builds a new ImmutableItem.
ImmutableItem.Builder	defaultValue(Object defaultValue) Initializes the value for the defaultValue attribute.
ImmutableItem.Builder	doc(String doc) Initializes the value for the doc attribute.
ImmutableItem.Builder	from(Plugin.Item instance) Fill a builder with attribute values from the provided Item instance.
ImmutableItem.Builder	group(String group) Initializes the value for the group attribute.
ImmutableItem.Builder	importance(org.apache.kafka.common.config.ConfigDef.Importance importance) Initializes the value for the importance attribute.
ImmutableItem.Builder	isRequired(boolean isRequired) Initializes the value for the isRequired attribute.
ImmutableItem.Builder	name(String name) Initializes the value for the name attribute.
ImmutableItem.Builder	type(org.apache.kafka.common.config.ConfigDef.Type type) Initializes the value for the type attribute.
ImmutableItem.Builder	validator(org.apache.kafka.common.config.ConfigDef.Validator validator) Initializes the value for the validator attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableItem.Builder from(Plugin.Item instance)

Fill a builder with attribute values from the provided Item instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

name

@CanIgnoreReturnValue
public final ImmutableItem.Builder name(String name)

Initializes the value for the name attribute.

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

importance

@CanIgnoreReturnValue
public final ImmutableItem.Builder importance(org.apache.kafka.common.config.ConfigDef.Importance importance)

Initializes the value for the importance attribute.

Parameters:

importance - The value for importance

Returns:

this builder for use in a chained invocation

doc

@CanIgnoreReturnValue
public final ImmutableItem.Builder doc(String doc)

Initializes the value for the doc attribute.

Parameters:

doc - The value for doc

Returns:

this builder for use in a chained invocation

defaultValue

@CanIgnoreReturnValue
public final ImmutableItem.Builder defaultValue(@Nullable
                                                                      Object defaultValue)

Initializes the value for the defaultValue attribute.

Parameters:

defaultValue - The value for defaultValue (can be null)

Returns:

this builder for use in a chained invocation

validator

@CanIgnoreReturnValue
public final ImmutableItem.Builder validator(@Nullable
                                                                   org.apache.kafka.common.config.ConfigDef.Validator validator)

Initializes the value for the validator attribute.

Parameters:

validator - The value for validator (can be null)

Returns:

this builder for use in a chained invocation

type

@CanIgnoreReturnValue
public final ImmutableItem.Builder type(org.apache.kafka.common.config.ConfigDef.Type type)

Initializes the value for the type attribute.

Parameters:

type - The value for type

Returns:

this builder for use in a chained invocation

group

@CanIgnoreReturnValue
public final ImmutableItem.Builder group(String group)

Initializes the value for the group attribute.

Parameters:

group - The value for group

Returns:

this builder for use in a chained invocation

isRequired

@CanIgnoreReturnValue
public final ImmutableItem.Builder isRequired(boolean isRequired)

Initializes the value for the isRequired attribute.

Parameters:

isRequired - The value for isRequired

Returns:

this builder for use in a chained invocation

build

public ImmutableItem build()

Builds a new ImmutableItem.

Returns:

An immutable instance of Item

Throws:

IllegalStateException - if any required attributes are missing