ImmutableTransformationExample (connect-utils-testing 1.0.3 API)

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

All Implemented Interfaces:: Notes, Plugin.Example, Plugin.TransformationExample

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

Immutable implementation of Plugin.TransformationExample.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableTransformationExample.Builder
Builds instances of type ImmutableTransformationExample.
- Nested classes/interfaces inherited from interface com.github.jcustenborder.kafka.connect.utils.templates.Notes
  Notes.Section

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableTransformationExample.Builder`	`builder()` Creates a builder for `ImmutableTransformationExample`.
`static ImmutableTransformationExample`	`copyOf(Plugin.TransformationExample instance)` Creates an immutable copy of a `Plugin.TransformationExample` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableTransformationExample` that have equal attribute values.
`String`	`getChildClass()`
`Map<String,String>`	`getConfig()`
`String`	`getDanger()`
`String`	`getDescription()`
`String`	`getIcon()`
`String`	`getImportant()`
`org.apache.kafka.connect.sink.SinkRecord`	`getInput()`
`String`	`getIntroduction()`
`String`	`getName()`
`String`	`getNote()`
`List<Notes.Section>`	`getSections()`
`String`	`getTip()`
`String`	`getTitle()`
`String`	`getWarning()`
`int`	`hashCode()` Computes a hash code from attributes: `warning`, `tip`, `important`, `danger`, `note`, `title`, `description`, `icon`, `introduction`, `sections`, `name`, `config`, `childClass`, `input`.
`String`	`toString()` Prints the immutable value `TransformationExample` with attribute values.
`ImmutableTransformationExample`	`withChildClass(String value)` Copy the current immutable object by setting a value for the `childClass` attribute.
`ImmutableTransformationExample`	`withConfig(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `config` map with the specified map.
`ImmutableTransformationExample`	`withDanger(String value)` Copy the current immutable object by setting a value for the `danger` attribute.
`ImmutableTransformationExample`	`withDescription(String value)` Copy the current immutable object by setting a value for the `description` attribute.
`ImmutableTransformationExample`	`withIcon(String value)` Copy the current immutable object by setting a value for the `icon` attribute.
`ImmutableTransformationExample`	`withImportant(String value)` Copy the current immutable object by setting a value for the `important` attribute.
`ImmutableTransformationExample`	`withInput(org.apache.kafka.connect.sink.SinkRecord value)` Copy the current immutable object by setting a value for the `input` attribute.
`ImmutableTransformationExample`	`withIntroduction(String value)` Copy the current immutable object by setting a value for the `introduction` attribute.
`ImmutableTransformationExample`	`withName(String value)` Copy the current immutable object by setting a value for the `name` attribute.
`ImmutableTransformationExample`	`withNote(String value)` Copy the current immutable object by setting a value for the `note` attribute.
`ImmutableTransformationExample`	`withSections(Iterable<? extends Notes.Section> elements)` Copy the current immutable object with elements that replace the content of `sections`.
`ImmutableTransformationExample`	`withSections(Notes.Section... elements)` Copy the current immutable object with elements that replace the content of `sections`.
`ImmutableTransformationExample`	`withTip(String value)` Copy the current immutable object by setting a value for the `tip` attribute.
`ImmutableTransformationExample`	`withTitle(String value)` Copy the current immutable object by setting a value for the `title` attribute.
`ImmutableTransformationExample`	`withWarning(String value)` Copy the current immutable object by setting a value for the `warning` attribute.

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

- Method Detail
  - getWarning
```
@Nullable
public String getWarning()
```
    Specified by:
    
    getWarning in interface Notes
    
    Returns:
    
    The value of the warning attribute
  - getTip
```
@Nullable
public String getTip()
```
    Specified by:
    
    getTip in interface Notes
    
    Returns:
    
    The value of the tip attribute
  - getImportant
```
@Nullable
public String getImportant()
```
    Specified by:
    
    getImportant in interface Notes
    
    Returns:
    
    The value of the important attribute
  - getDanger
```
@Nullable
public String getDanger()
```
    Specified by:
    
    getDanger in interface Notes
    
    Returns:
    
    The value of the danger attribute
  - getNote
```
@Nullable
public String getNote()
```
    Specified by:
    
    getNote in interface Notes
    
    Returns:
    
    The value of the note attribute
  - getTitle
```
@Nullable
public String getTitle()
```
    Specified by:
    
    getTitle in interface Notes
    
    Returns:
    
    The value of the title attribute
  - getDescription
```
@Nullable
public String getDescription()
```
    Specified by:
    
    getDescription in interface Notes
    
    Returns:
    
    The value of the description attribute
  - getIcon
```
@Nullable
public String getIcon()
```
    Specified by:
    
    getIcon in interface Notes
    
    Returns:
    
    The value of the icon attribute
  - getIntroduction
```
@Nullable
public String getIntroduction()
```
    Specified by:
    
    getIntroduction in interface Notes
    
    Returns:
    
    The value of the introduction attribute
  - getSections
```
@Nullable
public List<Notes.Section> getSections()
```
    Specified by:
    
    getSections in interface Notes
    
    Returns:
    
    The value of the sections attribute
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface Plugin.Example
    
    Returns:
    
    The value of the name attribute
  - getConfig
```
public Map<String,String> getConfig()
```
    Specified by:
    
    getConfig in interface Plugin.Example
    
    Returns:
    
    The value of the config attribute
  - getChildClass
```
@Nullable
public String getChildClass()
```
    Specified by:
    
    getChildClass in interface Plugin.TransformationExample
    
    Returns:
    
    The value of the childClass attribute
  - getInput
```
@Nullable
public org.apache.kafka.connect.sink.SinkRecord getInput()
```
    Specified by:
    
    getInput in interface Plugin.TransformationExample
    
    Returns:
    
    The value of the input attribute
  - withWarning
```
public final ImmutableTransformationExample withWarning(@Nullable
                                                        String value)
```
    Copy the current immutable object by setting a value for the warning attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for warning (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withTip
```
public final ImmutableTransformationExample withTip(@Nullable
                                                    String value)
```
    Copy the current immutable object by setting a value for the tip attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for tip (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withImportant
```
public final ImmutableTransformationExample withImportant(@Nullable
                                                          String value)
```
    Copy the current immutable object by setting a value for the important attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for important (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withDanger
```
public final ImmutableTransformationExample withDanger(@Nullable
                                                       String value)
```
    Copy the current immutable object by setting a value for the danger attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for danger (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withNote
```
public final ImmutableTransformationExample withNote(@Nullable
                                                     String value)
```
    Copy the current immutable object by setting a value for the note attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for note (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withTitle
```
public final ImmutableTransformationExample withTitle(@Nullable
                                                      String value)
```
    Copy the current immutable object by setting a value for the title attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for title (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withDescription
```
public final ImmutableTransformationExample withDescription(@Nullable
                                                            String value)
```
    Copy the current immutable object by setting a value for the description attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for description (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withIcon
```
public final ImmutableTransformationExample withIcon(@Nullable
                                                     String value)
```
    Copy the current immutable object by setting a value for the icon attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for icon (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withIntroduction
```
public final ImmutableTransformationExample withIntroduction(@Nullable
                                                             String value)
```
    Copy the current immutable object by setting a value for the introduction attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for introduction (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withSections
```
public final ImmutableTransformationExample withSections(@Nullable
                                                         Notes.Section... elements)
```
    Copy the current immutable object with elements that replace the content of sections.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withSections
```
public final ImmutableTransformationExample withSections(@Nullable
                                                         Iterable<? extends Notes.Section> elements)
```
    Copy the current immutable object with elements that replace the content of sections. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of sections elements to set
    
    Returns:
    
    A modified copy of this object
  - withName
```
public final ImmutableTransformationExample 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
  - withConfig
```
public final ImmutableTransformationExample withConfig(Map<String,? extends String> entries)
```
    Copy the current immutable object by replacing the config map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    entries - The entries to be added to the config map
    
    Returns:
    
    A modified copy of this object
  - withChildClass
```
public final ImmutableTransformationExample withChildClass(@Nullable
                                                           String value)
```
    Copy the current immutable object by setting a value for the childClass attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for childClass (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withInput
```
public final ImmutableTransformationExample withInput(@Nullable
                                                      org.apache.kafka.connect.sink.SinkRecord value)
```
    Copy the current immutable object by setting a value for the input attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for input (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 ImmutableTransformationExample 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: warning, tip, important, danger, note, title, description, icon, introduction, sections, name, config, childClass, input.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value TransformationExample with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableTransformationExample copyOf(Plugin.TransformationExample instance)
```
    Creates an immutable copy of a Plugin.TransformationExample 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 TransformationExample instance
  - builder
```
public static ImmutableTransformationExample.Builder builder()
```
    Creates a builder for ImmutableTransformationExample.
```
 ImmutableTransformationExample.builder()
    .warning(String | null) // nullable warning
    .tip(String | null) // nullable tip
    .important(String | null) // nullable important
    .danger(String | null) // nullable danger
    .note(String | null) // nullable note
    .title(String | null) // nullable title
    .description(String | null) // nullable description
    .icon(String | null) // nullable icon
    .introduction(String | null) // nullable introduction
    .sections(List&lt;com.github.jcustenborder.kafka.connect.utils.templates.Notes.Section&gt; | null) // nullable sections
    .name(String) // required name
    .putConfig|putAllConfig(String => String) // config mappings
    .childClass(String | null) // nullable childClass
    .input(org.apache.kafka.connect.sink.SinkRecord | null) // nullable input
    .build();
 
```
    Returns:
    
    A new ImmutableTransformationExample builder

Class ImmutableTransformationExample

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.jcustenborder.kafka.connect.utils.templates.Notes

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getWarning

getTip

getImportant

getDanger

getNote

getTitle

getDescription

getIcon

getIntroduction

getSections

getName

getConfig

getChildClass

getInput

withWarning

withTip

withImportant

withDanger

withNote

withTitle

withDescription

withIcon

withIntroduction

withSections

withSections

withName

withConfig

withChildClass

withInput

equals

hashCode

toString

copyOf

builder