ImmutableConfigProvider (connect-utils-testing 1.1.0 API)

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

All Implemented Interfaces:: Notes, Plugin.ConfigProvider, Plugin.Configurable

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

Immutable implementation of Plugin.ConfigProvider.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableConfigProvider.Builder`	`builder()` Creates a builder for `ImmutableConfigProvider`.
`static ImmutableConfigProvider`	`copyOf(Plugin.ConfigProvider instance)` Creates an immutable copy of a `Plugin.ConfigProvider` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableConfigProvider` that have equal attribute values.
`Class`	`getCls()`
`Plugin.Configuration`	`getConfiguration()`
`String`	`getDanger()`
`String`	`getDescription()`
`com.google.common.collect.ImmutableList<String>`	`getExamples()`
`String`	`getIcon()`
`String`	`getImportant()`
`String`	`getIntroduction()`
`String`	`getNote()`
`com.google.common.collect.ImmutableList<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`, `cls`, `configuration`, `examples`.
`String`	`toString()` Prints the immutable value `ConfigProvider` with attribute values.
`ImmutableConfigProvider`	`withCls(Class value)` Copy the current immutable object by setting a value for the `cls` attribute.
`ImmutableConfigProvider`	`withConfiguration(Plugin.Configuration value)` Copy the current immutable object by setting a value for the `configuration` attribute.
`ImmutableConfigProvider`	`withDanger(String value)` Copy the current immutable object by setting a value for the `danger` attribute.
`ImmutableConfigProvider`	`withDescription(String value)` Copy the current immutable object by setting a value for the `description` attribute.
`ImmutableConfigProvider`	`withExamples(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `examples`.
`ImmutableConfigProvider`	`withExamples(String... elements)` Copy the current immutable object with elements that replace the content of `examples`.
`ImmutableConfigProvider`	`withIcon(String value)` Copy the current immutable object by setting a value for the `icon` attribute.
`ImmutableConfigProvider`	`withImportant(String value)` Copy the current immutable object by setting a value for the `important` attribute.
`ImmutableConfigProvider`	`withIntroduction(String value)` Copy the current immutable object by setting a value for the `introduction` attribute.
`ImmutableConfigProvider`	`withNote(String value)` Copy the current immutable object by setting a value for the `note` attribute.
`ImmutableConfigProvider`	`withSections(Iterable<? extends Notes.Section> elements)` Copy the current immutable object with elements that replace the content of `sections`.
`ImmutableConfigProvider`	`withSections(Notes.Section... elements)` Copy the current immutable object with elements that replace the content of `sections`.
`ImmutableConfigProvider`	`withTip(String value)` Copy the current immutable object by setting a value for the `tip` attribute.
`ImmutableConfigProvider`	`withTitle(String value)` Copy the current immutable object by setting a value for the `title` attribute.
`ImmutableConfigProvider`	`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 com.google.common.collect.ImmutableList<Notes.Section> getSections()
```
    Specified by:
    
    getSections in interface Notes
    
    Returns:
    
    The value of the sections attribute
  - getCls
```
public Class getCls()
```
    Specified by:
    
    getCls in interface Plugin.Configurable
    
    Returns:
    
    The value of the cls attribute
  - getConfiguration
```
@Nullable
public Plugin.Configuration getConfiguration()
```
    Specified by:
    
    getConfiguration in interface Plugin.Configurable
    
    Returns:
    
    The value of the configuration attribute
  - getExamples
```
public com.google.common.collect.ImmutableList<String> getExamples()
```
    Specified by:
    
    getExamples in interface Plugin.Configurable
    
    Returns:
    
    The value of the examples attribute
  - withWarning
```
public final ImmutableConfigProvider 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 ImmutableConfigProvider 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 ImmutableConfigProvider 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 ImmutableConfigProvider 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 ImmutableConfigProvider 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 ImmutableConfigProvider 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 ImmutableConfigProvider 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 ImmutableConfigProvider 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 ImmutableConfigProvider 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 ImmutableConfigProvider 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 ImmutableConfigProvider 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
  - withCls
```
public final ImmutableConfigProvider withCls(Class value)
```
    Copy the current immutable object by setting a value for the cls attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for cls
    
    Returns:
    
    A modified copy of the this object
  - withConfiguration
```
public final ImmutableConfigProvider withConfiguration(@Nullable
                                                       Plugin.Configuration value)
```
    Copy the current immutable object by setting a value for the configuration attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for configuration (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withExamples
```
public final ImmutableConfigProvider withExamples(String... elements)
```
    Copy the current immutable object with elements that replace the content of examples.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withExamples
```
public final ImmutableConfigProvider withExamples(Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of examples. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of examples elements to set
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableConfigProvider 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, cls, configuration, examples.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value ConfigProvider with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableConfigProvider copyOf(Plugin.ConfigProvider instance)
```
    Creates an immutable copy of a Plugin.ConfigProvider 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 ConfigProvider instance
  - builder
```
public static ImmutableConfigProvider.Builder builder()
```
    Creates a builder for ImmutableConfigProvider.
```
 ImmutableConfigProvider.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
    .cls(Class) // required cls
    .configuration(com.github.jcustenborder.kafka.connect.utils.templates.Plugin.Configuration | null) // nullable configuration
    .addExamples|addAllExamples(String) // examples elements
    .build();
 
```
    Returns:
    
    A new ImmutableConfigProvider builder

Class ImmutableConfigProvider

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

getCls

getConfiguration

getExamples

withWarning

withTip

withImportant

withDanger

withNote

withTitle

withDescription

withIcon

withIntroduction

withSections

withSections

withCls

withConfiguration

withExamples

withExamples

equals

hashCode

toString

copyOf

builder