ImmutableConfigProviderExample (connect-utils-testing 1.0.3 API)

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

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

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

Immutable implementation of Plugin.ConfigProviderExample.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableConfigProviderExample.Builder`	`builder()` Creates a builder for `ImmutableConfigProviderExample`.
`static ImmutableConfigProviderExample`	`copyOf(Plugin.ConfigProviderExample instance)` Creates an immutable copy of a `Plugin.ConfigProviderExample` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableConfigProviderExample` that have equal attribute values.
`Map<String,String>`	`getConfig()`
`Map<String,String>`	`getConnectorConfig()`
`String`	`getDanger()`
`String`	`getDescription()`
`String`	`getIcon()`
`String`	`getImportant()`
`String`	`getIntroduction()`
`String`	`getName()`
`String`	`getNote()`
`String`	`getPrefix()`
`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`, `prefix`, `connectorConfig`.
`String`	`toString()` Prints the immutable value `ConfigProviderExample` with attribute values.
`ImmutableConfigProviderExample`	`withConfig(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `config` map with the specified map.
`ImmutableConfigProviderExample`	`withConnectorConfig(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `connectorConfig` map with the specified map.
`ImmutableConfigProviderExample`	`withDanger(String value)` Copy the current immutable object by setting a value for the `danger` attribute.
`ImmutableConfigProviderExample`	`withDescription(String value)` Copy the current immutable object by setting a value for the `description` attribute.
`ImmutableConfigProviderExample`	`withIcon(String value)` Copy the current immutable object by setting a value for the `icon` attribute.
`ImmutableConfigProviderExample`	`withImportant(String value)` Copy the current immutable object by setting a value for the `important` attribute.
`ImmutableConfigProviderExample`	`withIntroduction(String value)` Copy the current immutable object by setting a value for the `introduction` attribute.
`ImmutableConfigProviderExample`	`withName(String value)` Copy the current immutable object by setting a value for the `name` attribute.
`ImmutableConfigProviderExample`	`withNote(String value)` Copy the current immutable object by setting a value for the `note` attribute.
`ImmutableConfigProviderExample`	`withPrefix(String value)` Copy the current immutable object by setting a value for the `prefix` attribute.
`ImmutableConfigProviderExample`	`withSections(Iterable<? extends Notes.Section> elements)` Copy the current immutable object with elements that replace the content of `sections`.
`ImmutableConfigProviderExample`	`withSections(Notes.Section... elements)` Copy the current immutable object with elements that replace the content of `sections`.
`ImmutableConfigProviderExample`	`withTip(String value)` Copy the current immutable object by setting a value for the `tip` attribute.
`ImmutableConfigProviderExample`	`withTitle(String value)` Copy the current immutable object by setting a value for the `title` attribute.
`ImmutableConfigProviderExample`	`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
  - getPrefix
```
public String getPrefix()
```
    Specified by:
    
    getPrefix in interface Plugin.ConfigProviderExample
    
    Returns:
    
    The value of the prefix attribute
  - getConnectorConfig
```
public Map<String,String> getConnectorConfig()
```
    Specified by:
    
    getConnectorConfig in interface Plugin.ConfigProviderExample
    
    Returns:
    
    The value of the connectorConfig attribute
  - withWarning
```
public final ImmutableConfigProviderExample 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 ImmutableConfigProviderExample 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 ImmutableConfigProviderExample 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 ImmutableConfigProviderExample 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 ImmutableConfigProviderExample 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 ImmutableConfigProviderExample 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 ImmutableConfigProviderExample 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 ImmutableConfigProviderExample 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 ImmutableConfigProviderExample 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 ImmutableConfigProviderExample 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 ImmutableConfigProviderExample 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 ImmutableConfigProviderExample 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 ImmutableConfigProviderExample 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
  - withPrefix
```
public final ImmutableConfigProviderExample withPrefix(String value)
```
    Copy the current immutable object by setting a value for the prefix attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for prefix
    
    Returns:
    
    A modified copy of the this object
  - withConnectorConfig
```
public final ImmutableConfigProviderExample withConnectorConfig(Map<String,? extends String> entries)
```
    Copy the current immutable object by replacing the connectorConfig 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 connectorConfig map
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableConfigProviderExample 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, prefix, connectorConfig.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value ConfigProviderExample with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableConfigProviderExample copyOf(Plugin.ConfigProviderExample instance)
```
    Creates an immutable copy of a Plugin.ConfigProviderExample 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 ConfigProviderExample instance
  - builder
```
public static ImmutableConfigProviderExample.Builder builder()
```
    Creates a builder for ImmutableConfigProviderExample.
```
 ImmutableConfigProviderExample.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
    .prefix(String) // required prefix
    .putConnectorConfig|putAllConnectorConfig(String => String) // connectorConfig mappings
    .build();
 
```
    Returns:
    
    A new ImmutableConfigProviderExample builder

Class ImmutableConfigProviderExample

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

getPrefix

getConnectorConfig

withWarning

withTip

withImportant

withDanger

withNote

withTitle

withDescription

withIcon

withIntroduction

withSections

withSections

withName

withConfig

withPrefix

withConnectorConfig

equals

hashCode

toString

copyOf

builder