SmtpSessionFactoryConfig (NioSmtpClient 0.0.1-SNAPSHOT API)

java.lang.Object
- com.hubspot.smtp.client.SmtpSessionFactoryConfig

@ParametersAreNonnullByDefault
 @Generated(value={"Immutables.generator","AbstractSmtpSessionFactoryConfig"})
 @Immutable
public final class SmtpSessionFactoryConfig
extends Object

Immutable implementation of AbstractSmtpSessionFactoryConfig.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SmtpSessionFactoryConfig.Builder
Builds instances of type SmtpSessionFactoryConfig.

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

Field Summary

Fields
Modifier and Type	Field and Description
`static Executor`	`DIRECT_EXECUTOR` A default `Executor` to use when executing `CompletableFuture` callbacks which simply executes the callback in the netty event loop.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SmtpSessionFactoryConfig.Builder`	`builder()` Creates a builder for `SmtpSessionFactoryConfig`.
`boolean`	`equals(Object another)` This instance is equal to all instances of `SmtpSessionFactoryConfig` that have equal attribute values.
`io.netty.buffer.ByteBufAllocator`	`getAllocator()` A Netty `ByteBufAllocator` that will be used for all connections.
`Class<? extends io.netty.channel.Channel>`	`getChannelClass()` A Netty `Channel` implementation that will be used for all connections.
`io.netty.channel.EventLoopGroup`	`getEventLoopGroup()` A Netty `EventLoopGroup` that will be used for all connections.
`Executor`	`getExecutor()` An `Executor` that will be used to call `CompletableFuture` callbacks.
`Supplier<SSLEngine>`	`getSslEngineSupplier()` Creates an `SSLEngine` for use with STARTTLS connections.
`int`	`hashCode()` Computes a hash code from attributes: `executor`, `eventLoopGroup`, `allocator`, `sslEngineSupplier`, `channelClass`.
`static SmtpSessionFactoryConfig`	`nonProductionConfig()` Creates a configuration with a default `NioEventLoopGroup` and `Executor`.
`String`	`toString()` Prints the immutable value `SmtpSessionFactoryConfig` with attribute values.
`SmtpSessionFactoryConfig`	`withAllocator(io.netty.buffer.ByteBufAllocator allocator)` Copy the current immutable object by setting a value for the `allocator` attribute.
`SmtpSessionFactoryConfig`	`withChannelClass(Class<? extends io.netty.channel.Channel> channelClass)` Copy the current immutable object by setting a value for the `channelClass` attribute.
`SmtpSessionFactoryConfig`	`withEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)` Copy the current immutable object by setting a value for the `eventLoopGroup` attribute.
`SmtpSessionFactoryConfig`	`withExecutor(Executor executor)` Copy the current immutable object by setting a value for the `executor` attribute.
`SmtpSessionFactoryConfig`	`withSslEngineSupplier(Supplier<SSLEngine> sslEngineSupplier)` Copy the current immutable object by setting a value for the `sslEngineSupplier` attribute.

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

- Field Detail
  - DIRECT_EXECUTOR
```
public static final Executor DIRECT_EXECUTOR
```
    A default Executor to use when executing CompletableFuture callbacks which simply executes the callback in the netty event loop. This Executor should only be use when you can be sure your callback code never blocks.
- Method Detail
  - getExecutor
```
public Executor getExecutor()
```
    An Executor that will be used to call CompletableFuture callbacks.
  - getEventLoopGroup
```
public io.netty.channel.EventLoopGroup getEventLoopGroup()
```
    A Netty EventLoopGroup that will be used for all connections.
  - getAllocator
```
public io.netty.buffer.ByteBufAllocator getAllocator()
```
    A Netty ByteBufAllocator that will be used for all connections.
  - getSslEngineSupplier
```
public Supplier<SSLEngine> getSslEngineSupplier()
```
    Creates an SSLEngine for use with STARTTLS connections.
  - getChannelClass
```
public Class<? extends io.netty.channel.Channel> getChannelClass()
```
    A Netty Channel implementation that will be used for all connections.
  - withExecutor
```
public final SmtpSessionFactoryConfig withExecutor(Executor executor)
```
    Copy the current immutable object by setting a value for the executor attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    executor - A new value for executor
    
    Returns:
    
    A modified copy of the this object
  - withEventLoopGroup
```
public final SmtpSessionFactoryConfig withEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)
```
    Copy the current immutable object by setting a value for the eventLoopGroup attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    eventLoopGroup - A new value for eventLoopGroup
    
    Returns:
    
    A modified copy of the this object
  - withAllocator
```
public final SmtpSessionFactoryConfig withAllocator(io.netty.buffer.ByteBufAllocator allocator)
```
    Copy the current immutable object by setting a value for the allocator attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    allocator - A new value for allocator
    
    Returns:
    
    A modified copy of the this object
  - withSslEngineSupplier
```
public final SmtpSessionFactoryConfig withSslEngineSupplier(Supplier<SSLEngine> sslEngineSupplier)
```
    Copy the current immutable object by setting a value for the sslEngineSupplier attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    sslEngineSupplier - A new value for sslEngineSupplier
    
    Returns:
    
    A modified copy of the this object
  - withChannelClass
```
public final SmtpSessionFactoryConfig withChannelClass(Class<? extends io.netty.channel.Channel> channelClass)
```
    Copy the current immutable object by setting a value for the channelClass attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    channelClass - A new value for channelClass
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of SmtpSessionFactoryConfig 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: executor, eventLoopGroup, allocator, sslEngineSupplier, channelClass.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value SmtpSessionFactoryConfig with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - builder
```
public static SmtpSessionFactoryConfig.Builder builder()
```
    Creates a builder for SmtpSessionFactoryConfig.
    
    Returns:
    
    A new SmtpSessionFactoryConfig builder
  - nonProductionConfig
```
public static SmtpSessionFactoryConfig nonProductionConfig()
```
    Creates a configuration with a default NioEventLoopGroup and Executor. This is NOT suitable for a production environment but is useful for testing.

Class SmtpSessionFactoryConfig

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DIRECT_EXECUTOR

Method Detail

getExecutor

getEventLoopGroup

getAllocator

getSslEngineSupplier

getChannelClass

withExecutor

withEventLoopGroup

withAllocator

withSslEngineSupplier

withChannelClass

equals

hashCode

toString

builder

nonProductionConfig