ImmutableSchemaInput (connect-utils-testing 1.0.3 API)

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

All Implemented Interfaces:: Plugin.SchemaInput

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

Immutable implementation of Plugin.SchemaInput.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableSchemaInput.Builder
Builds instances of type ImmutableSchemaInput.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableSchemaInput.Builder`	`builder()` Creates a builder for `ImmutableSchemaInput`.
`static ImmutableSchemaInput`	`copyOf(Plugin.SchemaInput instance)` Creates an immutable copy of a `Plugin.SchemaInput` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableSchemaInput` that have equal attribute values.
`String`	`getDoc()`
`String`	`getFieldName()`
`com.google.common.collect.ImmutableList<Plugin.SchemaInput>`	`getFields()`
`String`	`getName()`
`String`	`getRefLink()`
`String`	`getSchemaLink()`
`String`	`getShortName()`
`String`	`getTable()`
`org.apache.kafka.connect.data.Schema.Type`	`getType()`
`int`	`hashCode()` Computes a hash code from attributes: `name`, `schemaLink`, `shortName`, `doc`, `isOptional`, `type`, `fieldName`, `fields`, `key`, `value`, `refLink`, `table`.
`boolean`	`isOptional()`
`Plugin.SchemaInput`	`key()`
`String`	`toString()` Prints the immutable value `SchemaInput` with attribute values.
`Plugin.SchemaInput`	`value()`
`ImmutableSchemaInput`	`withDoc(String value)` Copy the current immutable object by setting a value for the `doc` attribute.
`ImmutableSchemaInput`	`withFieldName(String value)` Copy the current immutable object by setting a value for the `fieldName` attribute.
`ImmutableSchemaInput`	`withFields(Iterable<? extends Plugin.SchemaInput> elements)` Copy the current immutable object with elements that replace the content of `fields`.
`ImmutableSchemaInput`	`withFields(Plugin.SchemaInput... elements)` Copy the current immutable object with elements that replace the content of `fields`.
`ImmutableSchemaInput`	`withIsOptional(boolean value)` Copy the current immutable object by setting a value for the `isOptional` attribute.
`ImmutableSchemaInput`	`withKey(Plugin.SchemaInput value)` Copy the current immutable object by setting a value for the `key` attribute.
`ImmutableSchemaInput`	`withName(String value)` Copy the current immutable object by setting a value for the `name` attribute.
`ImmutableSchemaInput`	`withType(org.apache.kafka.connect.data.Schema.Type value)` Copy the current immutable object by setting a value for the `type` attribute.
`ImmutableSchemaInput`	`withValue(Plugin.SchemaInput value)` Copy the current immutable object by setting a value for the `value` attribute.

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

- Method Detail
  - getName
```
@Nullable
public String getName()
```
    Specified by:
    
    getName in interface Plugin.SchemaInput
    
    Returns:
    
    The value of the name attribute
  - getSchemaLink
```
@Nullable
public String getSchemaLink()
```
    Specified by:
    
    getSchemaLink in interface Plugin.SchemaInput
    
    Returns:
    
    The computed-at-construction value of the schemaLink attribute
  - getShortName
```
@Nullable
public String getShortName()
```
    Specified by:
    
    getShortName in interface Plugin.SchemaInput
    
    Returns:
    
    The computed-at-construction value of the shortName attribute
  - getDoc
```
@Nullable
public String getDoc()
```
    Specified by:
    
    getDoc in interface Plugin.SchemaInput
    
    Returns:
    
    The value of the doc attribute
  - isOptional
```
public boolean isOptional()
```
    Specified by:
    
    isOptional in interface Plugin.SchemaInput
    
    Returns:
    
    The value of the isOptional attribute
  - getType
```
public org.apache.kafka.connect.data.Schema.Type getType()
```
    Specified by:
    
    getType in interface Plugin.SchemaInput
    
    Returns:
    
    The value of the type attribute
  - getFieldName
```
@Nullable
public String getFieldName()
```
    Specified by:
    
    getFieldName in interface Plugin.SchemaInput
    
    Returns:
    
    The value of the fieldName attribute
  - getFields
```
@Nullable
public com.google.common.collect.ImmutableList<Plugin.SchemaInput> getFields()
```
    Specified by:
    
    getFields in interface Plugin.SchemaInput
    
    Returns:
    
    The value of the fields attribute
  - key
```
@Nullable
public Plugin.SchemaInput key()
```
    Specified by:
    
    key in interface Plugin.SchemaInput
    
    Returns:
    
    The value of the key attribute
  - value
```
@Nullable
public Plugin.SchemaInput value()
```
    Specified by:
    
    value in interface Plugin.SchemaInput
    
    Returns:
    
    The value of the value attribute
  - getRefLink
```
public String getRefLink()
```
    Specified by:
    
    getRefLink in interface Plugin.SchemaInput
    
    Returns:
    
    The computed-at-construction value of the refLink attribute
  - getTable
```
public String getTable()
```
    Specified by:
    
    getTable in interface Plugin.SchemaInput
    
    Returns:
    
    The computed-at-construction value of the table attribute
  - withName
```
public final ImmutableSchemaInput withName(@Nullable
                                           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 (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withDoc
```
public final ImmutableSchemaInput withDoc(@Nullable
                                          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 (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withIsOptional
```
public final ImmutableSchemaInput withIsOptional(boolean value)
```
    Copy the current immutable object by setting a value for the isOptional attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isOptional
    
    Returns:
    
    A modified copy of the this object
  - withType
```
public final ImmutableSchemaInput withType(org.apache.kafka.connect.data.Schema.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
  - withFieldName
```
public final ImmutableSchemaInput withFieldName(@Nullable
                                                String value)
```
    Copy the current immutable object by setting a value for the fieldName attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for fieldName (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withFields
```
public final ImmutableSchemaInput withFields(@Nullable
                                             Plugin.SchemaInput... elements)
```
    Copy the current immutable object with elements that replace the content of fields.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withFields
```
public final ImmutableSchemaInput withFields(@Nullable
                                             Iterable<? extends Plugin.SchemaInput> elements)
```
    Copy the current immutable object with elements that replace the content of fields. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of fields elements to set
    
    Returns:
    
    A modified copy of this object
  - withKey
```
public final ImmutableSchemaInput withKey(@Nullable
                                          Plugin.SchemaInput value)
```
    Copy the current immutable object by setting a value for the key attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for key (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withValue
```
public final ImmutableSchemaInput withValue(@Nullable
                                            Plugin.SchemaInput value)
```
    Copy the current immutable object by setting a value for the value attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for value (can be null)
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableSchemaInput 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, schemaLink, shortName, doc, isOptional, type, fieldName, fields, key, value, refLink, table.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value SchemaInput with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableSchemaInput copyOf(Plugin.SchemaInput instance)
```
    Creates an immutable copy of a Plugin.SchemaInput 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 SchemaInput instance
  - builder
```
public static ImmutableSchemaInput.Builder builder()
```
    Creates a builder for ImmutableSchemaInput.
```
 ImmutableSchemaInput.builder()
    .name(String | null) // nullable name
    .doc(String | null) // nullable doc
    .isOptional(boolean) // required isOptional
    .type(org.apache.kafka.connect.data.Schema.Type) // required type
    .fieldName(String | null) // nullable fieldName
    .fields(List&lt;com.github.jcustenborder.kafka.connect.utils.templates.Plugin.SchemaInput&gt; | null) // nullable fields
    .key(com.github.jcustenborder.kafka.connect.utils.templates.Plugin.SchemaInput | null) // nullable key
    .value(com.github.jcustenborder.kafka.connect.utils.templates.Plugin.SchemaInput | null) // nullable value
    .build();
 
```
    Returns:
    
    A new ImmutableSchemaInput builder

Class ImmutableSchemaInput

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getSchemaLink

getShortName

getDoc

isOptional

getType

getFieldName

getFields

key

value

getRefLink

getTable

withName

withDoc

withIsOptional

withType

withFieldName

withFields

withFields

withKey

withValue

equals

hashCode

toString

copyOf

builder