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

Class ImmutableConfigProviderExample.Builder

java.lang.Object

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

Enclosing class:

ImmutableConfigProviderExample

@NotThreadSafe
public static final class ImmutableConfigProviderExample.Builder
extends Object

Builds instances of type ImmutableConfigProviderExample. 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
ImmutableConfigProviderExample.Builder	addAllSections(Iterable<? extends Notes.Section> elements) Adds elements to sections list.
ImmutableConfigProviderExample.Builder	addSections(Notes.Section... elements) Adds elements to sections list.
ImmutableConfigProviderExample.Builder	addSections(Notes.Section element) Adds one element to sections list.
ImmutableConfigProviderExample	build() Builds a new ImmutableConfigProviderExample.
ImmutableConfigProviderExample.Builder	config(Map<String,? extends String> entries) Sets or replaces all mappings from the specified map as entries for the config map.
ImmutableConfigProviderExample.Builder	connectorConfig(Map<String,? extends String> entries) Sets or replaces all mappings from the specified map as entries for the connectorConfig map.
ImmutableConfigProviderExample.Builder	danger(String danger) Initializes the value for the danger attribute.
ImmutableConfigProviderExample.Builder	description(String description) Initializes the value for the description attribute.
ImmutableConfigProviderExample.Builder	from(Notes instance) Fill a builder with attribute values from the provided com.github.jcustenborder.kafka.connect.utils.templates.Notes instance.
ImmutableConfigProviderExample.Builder	from(Plugin.ConfigProviderExample instance) Fill a builder with attribute values from the provided com.github.jcustenborder.kafka.connect.utils.templates.Plugin.ConfigProviderExample instance.
ImmutableConfigProviderExample.Builder	from(Plugin.Example instance) Fill a builder with attribute values from the provided com.github.jcustenborder.kafka.connect.utils.templates.Plugin.Example instance.
ImmutableConfigProviderExample.Builder	icon(String icon) Initializes the value for the icon attribute.
ImmutableConfigProviderExample.Builder	important(String important) Initializes the value for the important attribute.
ImmutableConfigProviderExample.Builder	introduction(String introduction) Initializes the value for the introduction attribute.
ImmutableConfigProviderExample.Builder	name(String name) Initializes the value for the name attribute.
ImmutableConfigProviderExample.Builder	note(String note) Initializes the value for the note attribute.
ImmutableConfigProviderExample.Builder	prefix(String prefix) Initializes the value for the prefix attribute.
ImmutableConfigProviderExample.Builder	putAllConfig(Map<String,? extends String> entries) Put all mappings from the specified map as entries to config map.
ImmutableConfigProviderExample.Builder	putAllConnectorConfig(Map<String,? extends String> entries) Put all mappings from the specified map as entries to connectorConfig map.
ImmutableConfigProviderExample.Builder	putConfig(Map.Entry<String,? extends String> entry) Put one entry to the config map.
ImmutableConfigProviderExample.Builder	putConfig(String key, String value) Put one entry to the config map.
ImmutableConfigProviderExample.Builder	putConnectorConfig(Map.Entry<String,? extends String> entry) Put one entry to the connectorConfig map.
ImmutableConfigProviderExample.Builder	putConnectorConfig(String key, String value) Put one entry to the connectorConfig map.
ImmutableConfigProviderExample.Builder	sections(Iterable<? extends Notes.Section> elements) Sets or replaces all elements for sections list.
ImmutableConfigProviderExample.Builder	tip(String tip) Initializes the value for the tip attribute.
ImmutableConfigProviderExample.Builder	title(String title) Initializes the value for the title attribute.
ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.Builder from(Plugin.ConfigProviderExample instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

@CanIgnoreReturnValue
public final ImmutableConfigProviderExample.Builder from(Plugin.Example instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

warning

@CanIgnoreReturnValue
public final ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.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 ImmutableConfigProviderExample.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

name

@CanIgnoreReturnValue
public final ImmutableConfigProviderExample.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

putConfig

@CanIgnoreReturnValue
public final ImmutableConfigProviderExample.Builder putConfig(String key,
                                                                                    String value)

Put one entry to the config map.

Parameters:

key - The key in the config map

value - The associated value in the config map

Returns:

this builder for use in a chained invocation

putConfig

@CanIgnoreReturnValue
public final ImmutableConfigProviderExample.Builder putConfig(Map.Entry<String,? extends String> entry)

Put one entry to the config map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

config

@CanIgnoreReturnValue
public final ImmutableConfigProviderExample.Builder config(Map<String,? extends String> entries)

Sets or replaces all mappings from the specified map as entries for the config map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the config map

Returns:

this builder for use in a chained invocation

putAllConfig

@CanIgnoreReturnValue
public final ImmutableConfigProviderExample.Builder putAllConfig(Map<String,? extends String> entries)

Put all mappings from the specified map as entries to config map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the config map

Returns:

this builder for use in a chained invocation

prefix

@CanIgnoreReturnValue
public final ImmutableConfigProviderExample.Builder prefix(String prefix)

Initializes the value for the prefix attribute.

Parameters:

prefix - The value for prefix

Returns:

this builder for use in a chained invocation

putConnectorConfig

@CanIgnoreReturnValue
public final ImmutableConfigProviderExample.Builder putConnectorConfig(String key,
                                                                                             String value)

Put one entry to the connectorConfig map.

Parameters:

key - The key in the connectorConfig map

value - The associated value in the connectorConfig map

Returns:

this builder for use in a chained invocation

putConnectorConfig

@CanIgnoreReturnValue
public final ImmutableConfigProviderExample.Builder putConnectorConfig(Map.Entry<String,? extends String> entry)

Put one entry to the connectorConfig map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

connectorConfig

@CanIgnoreReturnValue
public final ImmutableConfigProviderExample.Builder connectorConfig(Map<String,? extends String> entries)

Sets or replaces all mappings from the specified map as entries for the connectorConfig map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the connectorConfig map

Returns:

this builder for use in a chained invocation

putAllConnectorConfig

@CanIgnoreReturnValue
public final ImmutableConfigProviderExample.Builder putAllConnectorConfig(Map<String,? extends String> entries)

Put all mappings from the specified map as entries to connectorConfig map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the connectorConfig map

Returns:

this builder for use in a chained invocation

build

public ImmutableConfigProviderExample build()

Builds a new ImmutableConfigProviderExample.

Returns:

An immutable instance of ConfigProviderExample

Throws:

IllegalStateException - if any required attributes are missing