ImmutableSourceConnectorExample (connect-utils-testing 1.1.0 API)

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

All Implemented Interfaces:

Notes, Plugin.ConnectorExample, Plugin.Example, Plugin.SourceConnectorExample
```
@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableSourceConnectorExample
extends Object
implements Plugin.SourceConnectorExample
```
Immutable implementation of Plugin.SourceConnectorExample.
Use the builder to create immutable instances: ImmutableSourceConnectorExample.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableSourceConnectorExample.Builder
Builds instances of type ImmutableSourceConnectorExample.
- 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`	`ImmutableSourceConnectorExample.Builder` Builds instances of type `ImmutableSourceConnectorExample`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableSourceConnectorExample.Builder`	`builder()` Creates a builder for `ImmutableSourceConnectorExample`.
`static ImmutableSourceConnectorExample`	`copyOf(Plugin.SourceConnectorExample instance)` Creates an immutable copy of a `Plugin.SourceConnectorExample` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableSourceConnectorExample` that have equal attribute values.
`Map<String,String>`	`getConfig()`
`String`	`getDanger()`
`String`	`getDescription()`
`String`	`getIcon()`
`String`	`getImportant()`
`String`	`getIntroduction()`
`String`	`getName()`
`String`	`getNote()`
`org.apache.kafka.connect.source.SourceRecord`	`getOutput()`
`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`, `transformations`, `output`.
`String`	`toString()` Prints the immutable value `SourceConnectorExample` with attribute values.
`Map<String,Map<String,String>>`	`transformations()`
`ImmutableSourceConnectorExample`	`withConfig(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `config` map with the specified map.
`ImmutableSourceConnectorExample`	`withDanger(String value)` Copy the current immutable object by setting a value for the `danger` attribute.
`ImmutableSourceConnectorExample`	`withDescription(String value)` Copy the current immutable object by setting a value for the `description` attribute.
`ImmutableSourceConnectorExample`	`withIcon(String value)` Copy the current immutable object by setting a value for the `icon` attribute.
`ImmutableSourceConnectorExample`	`withImportant(String value)` Copy the current immutable object by setting a value for the `important` attribute.
`ImmutableSourceConnectorExample`	`withIntroduction(String value)` Copy the current immutable object by setting a value for the `introduction` attribute.
`ImmutableSourceConnectorExample`	`withName(String value)` Copy the current immutable object by setting a value for the `name` attribute.
`ImmutableSourceConnectorExample`	`withNote(String value)` Copy the current immutable object by setting a value for the `note` attribute.
`ImmutableSourceConnectorExample`	`withOutput(org.apache.kafka.connect.source.SourceRecord value)` Copy the current immutable object by setting a value for the `output` attribute.
`ImmutableSourceConnectorExample`	`withSections(Iterable<? extends Notes.Section> elements)` Copy the current immutable object with elements that replace the content of `sections`.
`ImmutableSourceConnectorExample`	`withSections(Notes.Section... elements)` Copy the current immutable object with elements that replace the content of `sections`.
`ImmutableSourceConnectorExample`	`withTip(String value)` Copy the current immutable object by setting a value for the `tip` attribute.
`ImmutableSourceConnectorExample`	`withTitle(String value)` Copy the current immutable object by setting a value for the `title` attribute.
`ImmutableSourceConnectorExample`	`withTransformations(Map<String,? extends Map<String,String>> entries)` Copy the current immutable object by replacing the `transformations` map with the specified map.
`ImmutableSourceConnectorExample`	`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
  - transformations
```
public Map<String,Map<String,String>> transformations()
```
    Specified by:
    
    transformations in interface Plugin.ConnectorExample
    
    Returns:
    
    The value of the transformations attribute
  - getOutput
```
@Nullable
public org.apache.kafka.connect.source.SourceRecord getOutput()
```
    Specified by:
    
    getOutput in interface Plugin.SourceConnectorExample
    
    Returns:
    
    The value of the output attribute
  - withWarning
```
public final ImmutableSourceConnectorExample 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 ImmutableSourceConnectorExample 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 ImmutableSourceConnectorExample 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 ImmutableSourceConnectorExample 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 ImmutableSourceConnectorExample 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 ImmutableSourceConnectorExample 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 ImmutableSourceConnectorExample 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 ImmutableSourceConnectorExample 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 ImmutableSourceConnectorExample 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 ImmutableSourceConnectorExample 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 ImmutableSourceConnectorExample 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 ImmutableSourceConnectorExample 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 ImmutableSourceConnectorExample 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
  - withTransformations
```
public final ImmutableSourceConnectorExample withTransformations(Map<String,? extends Map<String,String>> entries)
```
    Copy the current immutable object by replacing the transformations 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 transformations map
    
    Returns:
    
    A modified copy of this object
  - withOutput
```
public final ImmutableSourceConnectorExample withOutput(@Nullable
                                                        org.apache.kafka.connect.source.SourceRecord value)
```
    Copy the current immutable object by setting a value for the output attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for output (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 ImmutableSourceConnectorExample 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, transformations, output.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value SourceConnectorExample with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableSourceConnectorExample copyOf(Plugin.SourceConnectorExample instance)
```
    Creates an immutable copy of a Plugin.SourceConnectorExample 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 SourceConnectorExample instance
  - builder
```
public static ImmutableSourceConnectorExample.Builder builder()
```
    Creates a builder for ImmutableSourceConnectorExample.
```
 ImmutableSourceConnectorExample.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
    .putTransformations|putAllTransformations(String => Map&lt;String, String&gt;) // transformations mappings
    .output(org.apache.kafka.connect.source.SourceRecord | null) // nullable output
    .build();
 
```
    Returns:
    
    A new ImmutableSourceConnectorExample builder

Class ImmutableSourceConnectorExample

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

transformations

getOutput

withWarning

withTip

withImportant

withDanger

withNote

withTitle

withDescription

withIcon

withIntroduction

withSections

withSections

withName

withConfig

withTransformations

withOutput

equals

hashCode

toString

copyOf

builder