ImmutableItem (connect-utils-testing 1.1.0 API)

java.lang.Object
- com.github.jcustenborder.kafka.connect.utils.templates.ImmutableItem

All Implemented Interfaces:: Plugin.Item

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

Immutable implementation of Plugin.Item.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableItem.Builder
Builds instances of type ImmutableItem.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableItem.Builder` Builds instances of type `ImmutableItem`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableItem.Builder`	`builder()` Creates a builder for `ImmutableItem`.
`static ImmutableItem`	`copyOf(Plugin.Item instance)` Creates an immutable copy of a `Plugin.Item` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableItem` that have equal attribute values.
`Object`	`getDefaultValue()`
`String`	`getDoc()`
`String`	`getGroup()`
`org.apache.kafka.common.config.ConfigDef.Importance`	`getImportance()`
`String`	`getName()`
`org.apache.kafka.common.config.ConfigDef.Type`	`getType()`
`org.apache.kafka.common.config.ConfigDef.Validator`	`getValidator()`
`int`	`hashCode()` Computes a hash code from attributes: `name`, `importance`, `doc`, `defaultValue`, `validator`, `type`, `group`, `isRequired`.
`boolean`	`isRequired()`
`String`	`toString()` Prints the immutable value `Item` with attribute values.
`ImmutableItem`	`withDefaultValue(Object value)` Copy the current immutable object by setting a value for the `defaultValue` attribute.
`ImmutableItem`	`withDoc(String value)` Copy the current immutable object by setting a value for the `doc` attribute.
`ImmutableItem`	`withGroup(String value)` Copy the current immutable object by setting a value for the `group` attribute.
`ImmutableItem`	`withImportance(org.apache.kafka.common.config.ConfigDef.Importance value)` Copy the current immutable object by setting a value for the `importance` attribute.
`ImmutableItem`	`withIsRequired(boolean value)` Copy the current immutable object by setting a value for the `isRequired` attribute.
`ImmutableItem`	`withName(String value)` Copy the current immutable object by setting a value for the `name` attribute.
`ImmutableItem`	`withType(org.apache.kafka.common.config.ConfigDef.Type value)` Copy the current immutable object by setting a value for the `type` attribute.
`ImmutableItem`	`withValidator(org.apache.kafka.common.config.ConfigDef.Validator value)` Copy the current immutable object by setting a value for the `validator` attribute.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface Plugin.Item
    
    Returns:
    
    The value of the name attribute
  - getImportance
```
public org.apache.kafka.common.config.ConfigDef.Importance getImportance()
```
    Specified by:
    
    getImportance in interface Plugin.Item
    
    Returns:
    
    The value of the importance attribute
  - getDoc
```
public String getDoc()
```
    Specified by:
    
    getDoc in interface Plugin.Item
    
    Returns:
    
    The value of the doc attribute
  - getDefaultValue
```
@Nullable
public Object getDefaultValue()
```
    Specified by:
    
    getDefaultValue in interface Plugin.Item
    
    Returns:
    
    The value of the defaultValue attribute
  - getValidator
```
@Nullable
public org.apache.kafka.common.config.ConfigDef.Validator getValidator()
```
    Specified by:
    
    getValidator in interface Plugin.Item
    
    Returns:
    
    The value of the validator attribute
  - getType
```
public org.apache.kafka.common.config.ConfigDef.Type getType()
```
    Specified by:
    
    getType in interface Plugin.Item
    
    Returns:
    
    The value of the type attribute
  - getGroup
```
public String getGroup()
```
    Specified by:
    
    getGroup in interface Plugin.Item
    
    Returns:
    
    The value of the group attribute
  - isRequired
```
public boolean isRequired()
```
    Specified by:
    
    isRequired in interface Plugin.Item
    
    Returns:
    
    The value of the isRequired attribute
  - withName
```
public final ImmutableItem withName(String value)
```
    Copy the current immutable object by setting a value for the name attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for name
    
    Returns:
    
    A modified copy of the this object
  - withImportance
```
public final ImmutableItem withImportance(org.apache.kafka.common.config.ConfigDef.Importance value)
```
    Copy the current immutable object by setting a value for the importance attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for importance
    
    Returns:
    
    A modified copy of the this object
  - withDoc
```
public final ImmutableItem withDoc(String value)
```
    Copy the current immutable object by setting a value for the doc attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for doc
    
    Returns:
    
    A modified copy of the this object
  - withDefaultValue
```
public final ImmutableItem withDefaultValue(@Nullable
                                            Object value)
```
    Copy the current immutable object by setting a value for the defaultValue attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for defaultValue (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withValidator
```
public final ImmutableItem withValidator(@Nullable
                                         org.apache.kafka.common.config.ConfigDef.Validator value)
```
    Copy the current immutable object by setting a value for the validator attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for validator (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withType
```
public final ImmutableItem withType(org.apache.kafka.common.config.ConfigDef.Type value)
```
    Copy the current immutable object by setting a value for the type attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for type
    
    Returns:
    
    A modified copy of the this object
  - withGroup
```
public final ImmutableItem withGroup(String value)
```
    Copy the current immutable object by setting a value for the group attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for group
    
    Returns:
    
    A modified copy of the this object
  - withIsRequired
```
public final ImmutableItem withIsRequired(boolean value)
```
    Copy the current immutable object by setting a value for the isRequired attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isRequired
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableItem 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: name, importance, doc, defaultValue, validator, type, group, isRequired.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value Item with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableItem copyOf(Plugin.Item instance)
```
    Creates an immutable copy of a Plugin.Item 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 Item instance
  - builder
```
public static ImmutableItem.Builder builder()
```
    Creates a builder for ImmutableItem.
```
 ImmutableItem.builder()
    .name(String) // required name
    .importance(org.apache.kafka.common.config.ConfigDef.Importance) // required importance
    .doc(String) // required doc
    .defaultValue(Object | null) // nullable defaultValue
    .validator(org.apache.kafka.common.config.ConfigDef.Validator | null) // nullable validator
    .type(org.apache.kafka.common.config.ConfigDef.Type) // required type
    .group(String) // required group
    .isRequired(boolean) // required isRequired
    .build();
 
```
    Returns:
    
    A new ImmutableItem builder

Class ImmutableItem

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getImportance

getDoc

getDefaultValue

getValidator

getType

getGroup

isRequired

withName

withImportance

withDoc

withDefaultValue

withValidator

withType

withGroup

withIsRequired

equals

hashCode

toString

copyOf

builder