ImmutablePlugin (connect-utils-testing 1.0.3 API)

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

All Implemented Interfaces:: Notes, Plugin

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

Immutable implementation of Plugin.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutablePlugin.Builder
Builds instances of type ImmutablePlugin.
- Nested classes/interfaces inherited from interface com.github.jcustenborder.kafka.connect.utils.templates.Plugin
  Plugin.ConfigProvider, Plugin.ConfigProviderExample, Plugin.ConfigProviderExampleInput, Plugin.Configurable, Plugin.Configuration, Plugin.Connector, Plugin.ConnectorExample, Plugin.Converter, Plugin.ConverterExample, Plugin.ConverterExampleInput, Plugin.Example, Plugin.ExampleInput<T extends Plugin.Example>, Plugin.Group, Plugin.Item, Plugin.SchemaInput, Plugin.SinkConnector, Plugin.SinkConnectorExample, Plugin.SinkConnectorExampleInput, Plugin.SourceConnector, Plugin.SourceConnectorExample, Plugin.SourceConnectorExampleInput, Plugin.Transformation, Plugin.TransformationExample, Plugin.TransformationExampleInput
- 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`	`ImmutablePlugin.Builder` Builds instances of type `ImmutablePlugin`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutablePlugin.Builder`	`builder()` Creates a builder for `ImmutablePlugin`.
`static ImmutablePlugin`	`copyOf(Plugin instance)` Creates an immutable copy of a `Plugin` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutablePlugin` that have equal attribute values.
`com.google.common.collect.ImmutableList<Plugin.ConfigProvider>`	`getConfigProviders()`
`com.google.common.collect.ImmutableList<Plugin.Converter>`	`getConverters()`
`String`	`getDanger()`
`String`	`getDescription()`
`String`	`getIcon()`
`String`	`getImportant()`
`String`	`getIntroduction()`
`String`	`getNote()`
`String`	`getPluginName()`
`String`	`getPluginOwner()`
`com.google.common.collect.ImmutableList<Notes.Section>`	`getSections()`
`com.google.common.collect.ImmutableList<Plugin.SinkConnector>`	`getSinkConnectors()`
`com.google.common.collect.ImmutableList<Plugin.SourceConnector>`	`getSourceConnectors()`
`String`	`getTip()`
`String`	`getTitle()`
`com.google.common.collect.ImmutableList<Plugin.Transformation>`	`getTransformations()`
`String`	`getWarning()`
`int`	`hashCode()` Computes a hash code from attributes: `warning`, `tip`, `important`, `danger`, `note`, `title`, `description`, `icon`, `sections`, `introduction`, `pluginName`, `pluginOwner`, `transformations`, `sinkConnectors`, `sourceConnectors`, `converters`, `configProviders`.
`String`	`toString()` Prints the immutable value `Plugin` with attribute values.
`ImmutablePlugin`	`withConfigProviders(Iterable<? extends Plugin.ConfigProvider> elements)` Copy the current immutable object with elements that replace the content of `configProviders`.
`ImmutablePlugin`	`withConfigProviders(Plugin.ConfigProvider... elements)` Copy the current immutable object with elements that replace the content of `configProviders`.
`ImmutablePlugin`	`withConverters(Iterable<? extends Plugin.Converter> elements)` Copy the current immutable object with elements that replace the content of `converters`.
`ImmutablePlugin`	`withConverters(Plugin.Converter... elements)` Copy the current immutable object with elements that replace the content of `converters`.
`ImmutablePlugin`	`withDanger(String value)` Copy the current immutable object by setting a value for the `danger` attribute.
`ImmutablePlugin`	`withDescription(String value)` Copy the current immutable object by setting a value for the `description` attribute.
`ImmutablePlugin`	`withIcon(String value)` Copy the current immutable object by setting a value for the `icon` attribute.
`ImmutablePlugin`	`withImportant(String value)` Copy the current immutable object by setting a value for the `important` attribute.
`ImmutablePlugin`	`withIntroduction(String value)` Copy the current immutable object by setting a value for the `introduction` attribute.
`ImmutablePlugin`	`withNote(String value)` Copy the current immutable object by setting a value for the `note` attribute.
`ImmutablePlugin`	`withPluginName(String value)` Copy the current immutable object by setting a value for the `pluginName` attribute.
`ImmutablePlugin`	`withPluginOwner(String value)` Copy the current immutable object by setting a value for the `pluginOwner` attribute.
`ImmutablePlugin`	`withSections(Iterable<? extends Notes.Section> elements)` Copy the current immutable object with elements that replace the content of `sections`.
`ImmutablePlugin`	`withSections(Notes.Section... elements)` Copy the current immutable object with elements that replace the content of `sections`.
`ImmutablePlugin`	`withSinkConnectors(Iterable<? extends Plugin.SinkConnector> elements)` Copy the current immutable object with elements that replace the content of `sinkConnectors`.
`ImmutablePlugin`	`withSinkConnectors(Plugin.SinkConnector... elements)` Copy the current immutable object with elements that replace the content of `sinkConnectors`.
`ImmutablePlugin`	`withSourceConnectors(Iterable<? extends Plugin.SourceConnector> elements)` Copy the current immutable object with elements that replace the content of `sourceConnectors`.
`ImmutablePlugin`	`withSourceConnectors(Plugin.SourceConnector... elements)` Copy the current immutable object with elements that replace the content of `sourceConnectors`.
`ImmutablePlugin`	`withTip(String value)` Copy the current immutable object by setting a value for the `tip` attribute.
`ImmutablePlugin`	`withTitle(String value)` Copy the current immutable object by setting a value for the `title` attribute.
`ImmutablePlugin`	`withTransformations(Iterable<? extends Plugin.Transformation> elements)` Copy the current immutable object with elements that replace the content of `transformations`.
`ImmutablePlugin`	`withTransformations(Plugin.Transformation... elements)` Copy the current immutable object with elements that replace the content of `transformations`.
`ImmutablePlugin`	`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
  - getSections
```
@Nullable
public com.google.common.collect.ImmutableList<Notes.Section> getSections()
```
    Specified by:
    
    getSections in interface Notes
    
    Returns:
    
    The value of the sections attribute
  - getIntroduction
```
public String getIntroduction()
```
    Specified by:
    
    getIntroduction in interface Notes
    
    Specified by:
    
    getIntroduction in interface Plugin
    
    Returns:
    
    The value of the introduction attribute
  - getPluginName
```
public String getPluginName()
```
    Specified by:
    
    getPluginName in interface Plugin
    
    Returns:
    
    The value of the pluginName attribute
  - getPluginOwner
```
public String getPluginOwner()
```
    Specified by:
    
    getPluginOwner in interface Plugin
    
    Returns:
    
    The value of the pluginOwner attribute
  - getTransformations
```
public com.google.common.collect.ImmutableList<Plugin.Transformation> getTransformations()
```
    Specified by:
    
    getTransformations in interface Plugin
    
    Returns:
    
    The value of the transformations attribute
  - getSinkConnectors
```
public com.google.common.collect.ImmutableList<Plugin.SinkConnector> getSinkConnectors()
```
    Specified by:
    
    getSinkConnectors in interface Plugin
    
    Returns:
    
    The value of the sinkConnectors attribute
  - getSourceConnectors
```
public com.google.common.collect.ImmutableList<Plugin.SourceConnector> getSourceConnectors()
```
    Specified by:
    
    getSourceConnectors in interface Plugin
    
    Returns:
    
    The value of the sourceConnectors attribute
  - getConverters
```
public com.google.common.collect.ImmutableList<Plugin.Converter> getConverters()
```
    Specified by:
    
    getConverters in interface Plugin
    
    Returns:
    
    The value of the converters attribute
  - getConfigProviders
```
public com.google.common.collect.ImmutableList<Plugin.ConfigProvider> getConfigProviders()
```
    Specified by:
    
    getConfigProviders in interface Plugin
    
    Returns:
    
    The value of the configProviders attribute
  - withWarning
```
public final ImmutablePlugin 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 ImmutablePlugin 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 ImmutablePlugin 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 ImmutablePlugin 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 ImmutablePlugin 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 ImmutablePlugin 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 ImmutablePlugin 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 ImmutablePlugin 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
  - withSections
```
public final ImmutablePlugin 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 ImmutablePlugin 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
  - withIntroduction
```
public final ImmutablePlugin withIntroduction(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
    
    Returns:
    
    A modified copy of the this object
  - withPluginName
```
public final ImmutablePlugin withPluginName(String value)
```
    Copy the current immutable object by setting a value for the pluginName attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for pluginName
    
    Returns:
    
    A modified copy of the this object
  - withPluginOwner
```
public final ImmutablePlugin withPluginOwner(String value)
```
    Copy the current immutable object by setting a value for the pluginOwner attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for pluginOwner
    
    Returns:
    
    A modified copy of the this object
  - withTransformations
```
public final ImmutablePlugin withTransformations(Plugin.Transformation... elements)
```
    Copy the current immutable object with elements that replace the content of transformations.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withTransformations
```
public final ImmutablePlugin withTransformations(Iterable<? extends Plugin.Transformation> elements)
```
    Copy the current immutable object with elements that replace the content of transformations. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of transformations elements to set
    
    Returns:
    
    A modified copy of this object
  - withSinkConnectors
```
public final ImmutablePlugin withSinkConnectors(Plugin.SinkConnector... elements)
```
    Copy the current immutable object with elements that replace the content of sinkConnectors.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withSinkConnectors
```
public final ImmutablePlugin withSinkConnectors(Iterable<? extends Plugin.SinkConnector> elements)
```
    Copy the current immutable object with elements that replace the content of sinkConnectors. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of sinkConnectors elements to set
    
    Returns:
    
    A modified copy of this object
  - withSourceConnectors
```
public final ImmutablePlugin withSourceConnectors(Plugin.SourceConnector... elements)
```
    Copy the current immutable object with elements that replace the content of sourceConnectors.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withSourceConnectors
```
public final ImmutablePlugin withSourceConnectors(Iterable<? extends Plugin.SourceConnector> elements)
```
    Copy the current immutable object with elements that replace the content of sourceConnectors. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of sourceConnectors elements to set
    
    Returns:
    
    A modified copy of this object
  - withConverters
```
public final ImmutablePlugin withConverters(Plugin.Converter... elements)
```
    Copy the current immutable object with elements that replace the content of converters.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withConverters
```
public final ImmutablePlugin withConverters(Iterable<? extends Plugin.Converter> elements)
```
    Copy the current immutable object with elements that replace the content of converters. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of converters elements to set
    
    Returns:
    
    A modified copy of this object
  - withConfigProviders
```
public final ImmutablePlugin withConfigProviders(Plugin.ConfigProvider... elements)
```
    Copy the current immutable object with elements that replace the content of configProviders.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withConfigProviders
```
public final ImmutablePlugin withConfigProviders(Iterable<? extends Plugin.ConfigProvider> elements)
```
    Copy the current immutable object with elements that replace the content of configProviders. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of configProviders 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 ImmutablePlugin 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, sections, introduction, pluginName, pluginOwner, transformations, sinkConnectors, sourceConnectors, converters, configProviders.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value Plugin with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutablePlugin copyOf(Plugin instance)
```
    Creates an immutable copy of a Plugin 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 Plugin instance
  - builder
```
public static ImmutablePlugin.Builder builder()
```
    Creates a builder for ImmutablePlugin.
```
 ImmutablePlugin.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
    .sections(List&lt;com.github.jcustenborder.kafka.connect.utils.templates.Notes.Section&gt; | null) // nullable sections
    .introduction(String) // required introduction
    .pluginName(String) // required pluginName
    .pluginOwner(String) // required pluginOwner
    .addTransformations|addAllTransformations(com.github.jcustenborder.kafka.connect.utils.templates.Plugin.Transformation) // transformations elements
    .addSinkConnectors|addAllSinkConnectors(com.github.jcustenborder.kafka.connect.utils.templates.Plugin.SinkConnector) // sinkConnectors elements
    .addSourceConnectors|addAllSourceConnectors(com.github.jcustenborder.kafka.connect.utils.templates.Plugin.SourceConnector) // sourceConnectors elements
    .addConverters|addAllConverters(com.github.jcustenborder.kafka.connect.utils.templates.Plugin.Converter) // converters elements
    .addConfigProviders|addAllConfigProviders(com.github.jcustenborder.kafka.connect.utils.templates.Plugin.ConfigProvider) // configProviders elements
    .build();
 
```
    Returns:
    
    A new ImmutablePlugin builder

Class ImmutablePlugin

Nested Class Summary

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

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

getSections

getIntroduction

getPluginName

getPluginOwner

getTransformations

getSinkConnectors

getSourceConnectors

getConverters

getConfigProviders

withWarning

withTip

withImportant

withDanger

withNote

withTitle

withDescription

withIcon

withSections

withSections

withIntroduction

withPluginName

withPluginOwner

withTransformations

withTransformations

withSinkConnectors

withSinkConnectors

withSourceConnectors

withSourceConnectors

withConverters

withConverters

withConfigProviders

withConfigProviders

equals

hashCode

toString

copyOf

builder