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

Class ImmutableTransformation.Builder

java.lang.Object

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

Enclosing class:

ImmutableTransformation

@NotThreadSafe
public static final class ImmutableTransformation.Builder
extends Object

Builds instances of type ImmutableTransformation. 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
ImmutableTransformation.Builder	addAllExamples(Iterable<String> elements) Adds elements to examples list.
ImmutableTransformation.Builder	addAllSections(Iterable<? extends Notes.Section> elements) Adds elements to sections list.
ImmutableTransformation.Builder	addExamples(String... elements) Adds elements to examples list.
ImmutableTransformation.Builder	addExamples(String element) Adds one element to examples list.
ImmutableTransformation.Builder	addSections(Notes.Section... elements) Adds elements to sections list.
ImmutableTransformation.Builder	addSections(Notes.Section element) Adds one element to sections list.
ImmutableTransformation	build() Builds a new ImmutableTransformation.
ImmutableTransformation.Builder	cls(Class cls) Initializes the value for the cls attribute.
ImmutableTransformation.Builder	configuration(Plugin.Configuration configuration) Initializes the value for the configuration attribute.
ImmutableTransformation.Builder	danger(String danger) Initializes the value for the danger attribute.
ImmutableTransformation.Builder	description(String description) Initializes the value for the description attribute.
ImmutableTransformation.Builder	examples(Iterable<String> elements) Sets or replaces all elements for examples list.
ImmutableTransformation.Builder	from(Notes instance) Fill a builder with attribute values from the provided com.github.jcustenborder.kafka.connect.utils.templates.Notes instance.
ImmutableTransformation.Builder	from(Plugin.Configurable instance) Fill a builder with attribute values from the provided com.github.jcustenborder.kafka.connect.utils.templates.Plugin.Configurable instance.
ImmutableTransformation.Builder	from(Plugin.Transformation instance) Fill a builder with attribute values from the provided com.github.jcustenborder.kafka.connect.utils.templates.Plugin.Transformation instance.
ImmutableTransformation.Builder	icon(String icon) Initializes the value for the icon attribute.
ImmutableTransformation.Builder	important(String important) Initializes the value for the important attribute.
ImmutableTransformation.Builder	introduction(String introduction) Initializes the value for the introduction attribute.
ImmutableTransformation.Builder	isKeyValue(boolean isKeyValue) Initializes the value for the isKeyValue attribute.
ImmutableTransformation.Builder	key(Class key) Initializes the value for the key attribute.
ImmutableTransformation.Builder	note(String note) Initializes the value for the note attribute.
ImmutableTransformation.Builder	sections(Iterable<? extends Notes.Section> elements) Sets or replaces all elements for sections list.
ImmutableTransformation.Builder	tip(String tip) Initializes the value for the tip attribute.
ImmutableTransformation.Builder	title(String title) Initializes the value for the title attribute.
ImmutableTransformation.Builder	value(Class value) Initializes the value for the value attribute.
ImmutableTransformation.Builder	warning(String warning) Initializes the value for the warning 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 ImmutableTransformation.Builder from(Notes instance)

Fill a builder with attribute values from the provided com.github.jcustenborder.kafka.connect.utils.templates.Notes instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder from(Plugin.Configurable instance)

Fill a builder with attribute values from the provided com.github.jcustenborder.kafka.connect.utils.templates.Plugin.Configurable instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder from(Plugin.Transformation instance)

Fill a builder with attribute values from the provided com.github.jcustenborder.kafka.connect.utils.templates.Plugin.Transformation instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

warning

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder warning(@Nullable
                                                                           String warning)

Initializes the value for the warning attribute.

Parameters:

warning - The value for warning (can be null)

Returns:

this builder for use in a chained invocation

tip

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder tip(@Nullable
                                                                       String tip)

Initializes the value for the tip attribute.

Parameters:

tip - The value for tip (can be null)

Returns:

this builder for use in a chained invocation

important

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder important(@Nullable
                                                                             String important)

Initializes the value for the important attribute.

Parameters:

important - The value for important (can be null)

Returns:

this builder for use in a chained invocation

danger

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder danger(@Nullable
                                                                          String danger)

Initializes the value for the danger attribute.

Parameters:

danger - The value for danger (can be null)

Returns:

this builder for use in a chained invocation

note

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder note(@Nullable
                                                                        String note)

Initializes the value for the note attribute.

Parameters:

note - The value for note (can be null)

Returns:

this builder for use in a chained invocation

title

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder title(@Nullable
                                                                         String title)

Initializes the value for the title attribute.

Parameters:

title - The value for title (can be null)

Returns:

this builder for use in a chained invocation

description

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder description(@Nullable
                                                                               String description)

Initializes the value for the description attribute.

Parameters:

description - The value for description (can be null)

Returns:

this builder for use in a chained invocation

icon

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder icon(@Nullable
                                                                        String icon)

Initializes the value for the icon attribute.

Parameters:

icon - The value for icon (can be null)

Returns:

this builder for use in a chained invocation

introduction

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder introduction(@Nullable
                                                                                String introduction)

Initializes the value for the introduction attribute.

Parameters:

introduction - The value for introduction (can be null)

Returns:

this builder for use in a chained invocation

addSections

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder addSections(Notes.Section element)

Adds one element to sections list.

Parameters:

element - A sections element

Returns:

this builder for use in a chained invocation

addSections

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder addSections(Notes.Section... elements)

Adds elements to sections list.

Parameters:

elements - An array of sections elements

Returns:

this builder for use in a chained invocation

sections

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder sections(@Nullable
                                                                            Iterable<? extends Notes.Section> elements)

Sets or replaces all elements for sections list.

Parameters:

elements - An iterable of sections elements

Returns:

this builder for use in a chained invocation

addAllSections

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder addAllSections(Iterable<? extends Notes.Section> elements)

Adds elements to sections list.

Parameters:

elements - An iterable of sections elements

Returns:

this builder for use in a chained invocation

cls

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder cls(Class cls)

Initializes the value for the cls attribute.

Parameters:

cls - The value for cls

Returns:

this builder for use in a chained invocation

configuration

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder configuration(@Nullable
                                                                                 Plugin.Configuration configuration)

Initializes the value for the configuration attribute.

Parameters:

configuration - The value for configuration (can be null)

Returns:

this builder for use in a chained invocation

addExamples

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder addExamples(String element)

Adds one element to examples list.

Parameters:

element - A examples element

Returns:

this builder for use in a chained invocation

addExamples

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder addExamples(String... elements)

Adds elements to examples list.

Parameters:

elements - An array of examples elements

Returns:

this builder for use in a chained invocation

examples

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder examples(Iterable<String> elements)

Sets or replaces all elements for examples list.

Parameters:

elements - An iterable of examples elements

Returns:

this builder for use in a chained invocation

addAllExamples

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder addAllExamples(Iterable<String> elements)

Adds elements to examples list.

Parameters:

elements - An iterable of examples elements

Returns:

this builder for use in a chained invocation

isKeyValue

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder isKeyValue(boolean isKeyValue)

Initializes the value for the isKeyValue attribute.

Parameters:

isKeyValue - The value for isKeyValue

Returns:

this builder for use in a chained invocation

key

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder key(@Nullable
                                                                       Class key)

Initializes the value for the key attribute.

Parameters:

key - The value for key (can be null)

Returns:

this builder for use in a chained invocation

value

@CanIgnoreReturnValue
public final ImmutableTransformation.Builder value(@Nullable
                                                                         Class value)

Initializes the value for the value attribute.

Parameters:

value - The value for value (can be null)

Returns:

this builder for use in a chained invocation

build

public ImmutableTransformation build()

Builds a new ImmutableTransformation.

Returns:

An immutable instance of Transformation

Throws:

IllegalStateException - if any required attributes are missing