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

Class ImmutableConfiguration

java.lang.Object

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

All Implemented Interfaces:

Plugin.Configuration

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableConfiguration
extends Object
implements Plugin.Configuration

Immutable implementation of Plugin.Configuration.

Use the builder to create immutable instances: ImmutableConfiguration.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableConfiguration.Builder Builds instances of type ImmutableConfiguration.

Method Summary

Modifier and Type	Method and Description
static ImmutableConfiguration.Builder	builder() Creates a builder for ImmutableConfiguration.
static ImmutableConfiguration	copyOf(Plugin.Configuration instance) Creates an immutable copy of a Plugin.Configuration value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableConfiguration that have equal attribute values.
org.apache.kafka.common.config.ConfigDef	getConfigDef()
com.google.common.collect.ImmutableList<Plugin.Group>	getGroups()
com.google.common.collect.ImmutableList<Plugin.Item>	getRequiredConfigs()
int	hashCode() Computes a hash code from attributes: configDef, groups, requiredConfigs.
String	toString() Prints the immutable value Configuration with attribute values.
ImmutableConfiguration	withConfigDef(org.apache.kafka.common.config.ConfigDef value) Copy the current immutable object by setting a value for the configDef attribute.
ImmutableConfiguration	withGroups(Iterable<? extends Plugin.Group> elements) Copy the current immutable object with elements that replace the content of groups.
ImmutableConfiguration	withGroups(Plugin.Group... elements) Copy the current immutable object with elements that replace the content of groups.
ImmutableConfiguration	withRequiredConfigs(Iterable<? extends Plugin.Item> elements) Copy the current immutable object with elements that replace the content of requiredConfigs.
ImmutableConfiguration	withRequiredConfigs(Plugin.Item... elements) Copy the current immutable object with elements that replace the content of requiredConfigs.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getConfigDef

public org.apache.kafka.common.config.ConfigDef getConfigDef()

Specified by:

getConfigDef in interface Plugin.Configuration

Returns:

The value of the configDef attribute

getGroups

public com.google.common.collect.ImmutableList<Plugin.Group> getGroups()

Specified by:

getGroups in interface Plugin.Configuration

Returns:

The value of the groups attribute

getRequiredConfigs

public com.google.common.collect.ImmutableList<Plugin.Item> getRequiredConfigs()

Specified by:

getRequiredConfigs in interface Plugin.Configuration

Returns:

The value of the requiredConfigs attribute

withConfigDef

public final ImmutableConfiguration withConfigDef(org.apache.kafka.common.config.ConfigDef value)

Copy the current immutable object by setting a value for the configDef attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for configDef

Returns:

A modified copy of the this object

withGroups

public final ImmutableConfiguration withGroups(Plugin.Group... elements)

Copy the current immutable object with elements that replace the content of groups.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withGroups

public final ImmutableConfiguration withGroups(Iterable<? extends Plugin.Group> elements)

Copy the current immutable object with elements that replace the content of groups. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of groups elements to set

Returns:

A modified copy of this object

withRequiredConfigs

public final ImmutableConfiguration withRequiredConfigs(Plugin.Item... elements)

Copy the current immutable object with elements that replace the content of requiredConfigs.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withRequiredConfigs

public final ImmutableConfiguration withRequiredConfigs(Iterable<? extends Plugin.Item> elements)

Copy the current immutable object with elements that replace the content of requiredConfigs. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of requiredConfigs elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableConfiguration that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: configDef, groups, requiredConfigs.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Configuration with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableConfiguration copyOf(Plugin.Configuration instance)

Creates an immutable copy of a Plugin.Configuration value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable Configuration instance

builder

public static ImmutableConfiguration.Builder builder()

Creates a builder for ImmutableConfiguration.

 ImmutableConfiguration.builder()
    .configDef(org.apache.kafka.common.config.ConfigDef) // required configDef
    .addGroups|addAllGroups(com.github.jcustenborder.kafka.connect.utils.templates.Plugin.Group) // groups elements
    .addRequiredConfigs|addAllRequiredConfigs(com.github.jcustenborder.kafka.connect.utils.templates.Plugin.Item) // requiredConfigs elements
    .build();
 

Returns:

A new ImmutableConfiguration builder