ImmutableDownloadConfig (Flapdoodle Embedded Process Util 3.0.1 API)

java.lang.Object
- de.flapdoodle.embed.process.config.store.ImmutableDownloadConfig

All Implemented Interfaces:

DownloadConfig
```
@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableDownloadConfig
extends Object
implements DownloadConfig
```
Immutable implementation of DownloadConfig.
Use the builder to create immutable instances: ImmutableDownloadConfig.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableDownloadConfig.Builder
Builds instances of type ImmutableDownloadConfig.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableDownloadConfig.Builder`	`builder()` Creates a builder for `ImmutableDownloadConfig`.
`static ImmutableDownloadConfig`	`copyOf(DownloadConfig instance)` Creates an immutable copy of a `DownloadConfig` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableDownloadConfig` that have equal attribute values.
`Directory`	`getArtifactStorePath()`
`DistributionDownloadPath`	`getDownloadPath()`
`String`	`getDownloadPrefix()`
`TempNaming`	`getFileNaming()`
`PackageResolver`	`getPackageResolver()`
`ProgressListener`	`getProgressListener()`
`TimeoutConfig`	`getTimeoutConfig()`
`String`	`getUserAgent()`
`int`	`hashCode()` Computes a hash code from attributes: `downloadPath`, `progressListener`, `artifactStorePath`, `fileNaming`, `downloadPrefix`, `userAgent`, `packageResolver`, `timeoutConfig`, `proxyFactory`.
`Optional<ProxyFactory>`	`proxyFactory()`
`String`	`toString()` Prints the immutable value `DownloadConfig` with attribute values.
`ImmutableDownloadConfig`	`withArtifactStorePath(Directory value)` Copy the current immutable object by setting a value for the `artifactStorePath` attribute.
`ImmutableDownloadConfig`	`withDownloadPath(DistributionDownloadPath value)` Copy the current immutable object by setting a value for the `downloadPath` attribute.
`ImmutableDownloadConfig`	`withDownloadPrefix(String value)` Copy the current immutable object by setting a value for the `downloadPrefix` attribute.
`ImmutableDownloadConfig`	`withFileNaming(TempNaming value)` Copy the current immutable object by setting a value for the `fileNaming` attribute.
`ImmutableDownloadConfig`	`withPackageResolver(PackageResolver value)` Copy the current immutable object by setting a value for the `packageResolver` attribute.
`ImmutableDownloadConfig`	`withProgressListener(ProgressListener value)` Copy the current immutable object by setting a value for the `progressListener` attribute.
`ImmutableDownloadConfig`	`withProxyFactory(Optional<? extends ProxyFactory> optional)` Copy the current immutable object by setting an optional value for the `proxyFactory` attribute.
`ImmutableDownloadConfig`	`withProxyFactory(ProxyFactory value)` Copy the current immutable object by setting a present value for the optional `proxyFactory` attribute.
`ImmutableDownloadConfig`	`withTimeoutConfig(TimeoutConfig value)` Copy the current immutable object by setting a value for the `timeoutConfig` attribute.
`ImmutableDownloadConfig`	`withUserAgent(String value)` Copy the current immutable object by setting a value for the `userAgent` attribute.

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

- Method Detail
  - getDownloadPath
```
public DistributionDownloadPath getDownloadPath()
```
    Specified by:
    
    getDownloadPath in interface DownloadConfig
    
    Returns:
    
    The value of the downloadPath attribute
  - getProgressListener
```
public ProgressListener getProgressListener()
```
    Specified by:
    
    getProgressListener in interface DownloadConfig
    
    Returns:
    
    The value of the progressListener attribute
  - getArtifactStorePath
```
public Directory getArtifactStorePath()
```
    Specified by:
    
    getArtifactStorePath in interface DownloadConfig
    
    Returns:
    
    The value of the artifactStorePath attribute
  - getFileNaming
```
public TempNaming getFileNaming()
```
    Specified by:
    
    getFileNaming in interface DownloadConfig
    
    Returns:
    
    The value of the fileNaming attribute
  - getDownloadPrefix
```
public String getDownloadPrefix()
```
    Specified by:
    
    getDownloadPrefix in interface DownloadConfig
    
    Returns:
    
    The value of the downloadPrefix attribute
  - getUserAgent
```
public String getUserAgent()
```
    Specified by:
    
    getUserAgent in interface DownloadConfig
    
    Returns:
    
    The value of the userAgent attribute
  - getPackageResolver
```
public PackageResolver getPackageResolver()
```
    Specified by:
    
    getPackageResolver in interface DownloadConfig
    
    Returns:
    
    The value of the packageResolver attribute
  - getTimeoutConfig
```
public TimeoutConfig getTimeoutConfig()
```
    Specified by:
    
    getTimeoutConfig in interface DownloadConfig
    
    Returns:
    
    The value of the timeoutConfig attribute
  - proxyFactory
```
public Optional<ProxyFactory> proxyFactory()
```
    Specified by:
    
    proxyFactory in interface DownloadConfig
    
    Returns:
    
    The value of the proxyFactory attribute
  - withDownloadPath
```
public final ImmutableDownloadConfig withDownloadPath(DistributionDownloadPath value)
```
    Copy the current immutable object by setting a value for the downloadPath attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for downloadPath
    
    Returns:
    
    A modified copy of the this object
  - withProgressListener
```
public final ImmutableDownloadConfig withProgressListener(ProgressListener value)
```
    Copy the current immutable object by setting a value for the progressListener attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for progressListener
    
    Returns:
    
    A modified copy of the this object
  - withArtifactStorePath
```
public final ImmutableDownloadConfig withArtifactStorePath(Directory value)
```
    Copy the current immutable object by setting a value for the artifactStorePath attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for artifactStorePath
    
    Returns:
    
    A modified copy of the this object
  - withFileNaming
```
public final ImmutableDownloadConfig withFileNaming(TempNaming value)
```
    Copy the current immutable object by setting a value for the fileNaming attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for fileNaming
    
    Returns:
    
    A modified copy of the this object
  - withDownloadPrefix
```
public final ImmutableDownloadConfig withDownloadPrefix(String value)
```
    Copy the current immutable object by setting a value for the downloadPrefix attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for downloadPrefix
    
    Returns:
    
    A modified copy of the this object
  - withUserAgent
```
public final ImmutableDownloadConfig withUserAgent(String value)
```
    Copy the current immutable object by setting a value for the userAgent attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for userAgent
    
    Returns:
    
    A modified copy of the this object
  - withPackageResolver
```
public final ImmutableDownloadConfig withPackageResolver(PackageResolver value)
```
    Copy the current immutable object by setting a value for the packageResolver attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for packageResolver
    
    Returns:
    
    A modified copy of the this object
  - withTimeoutConfig
```
public final ImmutableDownloadConfig withTimeoutConfig(TimeoutConfig value)
```
    Copy the current immutable object by setting a value for the timeoutConfig attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for timeoutConfig
    
    Returns:
    
    A modified copy of the this object
  - withProxyFactory
```
public final ImmutableDownloadConfig withProxyFactory(ProxyFactory value)
```
    Copy the current immutable object by setting a present value for the optional proxyFactory attribute.
    
    Parameters:
    
    value - The value for proxyFactory
    
    Returns:
    
    A modified copy of this object
  - withProxyFactory
```
public final ImmutableDownloadConfig withProxyFactory(Optional<? extends ProxyFactory> optional)
```
    Copy the current immutable object by setting an optional value for the proxyFactory attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for proxyFactory
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of ImmutableDownloadConfig 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: downloadPath, progressListener, artifactStorePath, fileNaming, downloadPrefix, userAgent, packageResolver, timeoutConfig, proxyFactory.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value DownloadConfig with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableDownloadConfig copyOf(DownloadConfig instance)
```
    Creates an immutable copy of a DownloadConfig 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 DownloadConfig instance
  - builder
```
public static ImmutableDownloadConfig.Builder builder()
```
    Creates a builder for ImmutableDownloadConfig.
```
 ImmutableDownloadConfig.builder()
    .downloadPath(de.flapdoodle.embed.process.config.store.DistributionDownloadPath) // required downloadPath
    .progressListener(de.flapdoodle.embed.process.io.progress.ProgressListener) // required progressListener
    .artifactStorePath(de.flapdoodle.embed.process.io.directories.Directory) // required artifactStorePath
    .fileNaming(de.flapdoodle.embed.process.extract.TempNaming) // required fileNaming
    .downloadPrefix(String) // required downloadPrefix
    .userAgent(String) // required userAgent
    .packageResolver(de.flapdoodle.embed.process.config.store.PackageResolver) // required packageResolver
    .timeoutConfig(de.flapdoodle.embed.process.config.store.TimeoutConfig) // optional timeoutConfig
    .proxyFactory(de.flapdoodle.embed.process.config.store.ProxyFactory) // optional proxyFactory
    .build();
 
```
    Specified by:
    
    builder in interface DownloadConfig
    
    Returns:
    
    A new ImmutableDownloadConfig builder

Class ImmutableDownloadConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getDownloadPath

getProgressListener

getArtifactStorePath

getFileNaming

getDownloadPrefix

getUserAgent

getPackageResolver

getTimeoutConfig

proxyFactory

withDownloadPath

withProgressListener

withArtifactStorePath

withFileNaming

withDownloadPrefix

withUserAgent

withPackageResolver

withTimeoutConfig

withProxyFactory

withProxyFactory

equals

hashCode

toString

copyOf

builder