java.lang.Object
- com.io7m.brooklime.api.BLNexusClientConfiguration

All Implemented Interfaces:: BLNexusClientConfigurationType

public final class BLNexusClientConfiguration
extends java.lang.Object
implements BLNexusClientConfigurationType

The client configuration.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class BLNexusClientConfiguration.Builder
Builds instances of type BLNexusClientConfiguration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BLApplicationVersion`	`applicationVersion()`
`java.net.URI`	`baseURI()`
`static BLNexusClientConfiguration.Builder`	`builder()`	Creates a builder for `BLNexusClientConfiguration`.
`static BLNexusClientConfiguration`	`copyOf(BLNexusClientConfigurationType instance)`	Creates an immutable copy of a `BLNexusClientConfigurationType` value.
`boolean`	`equals(java.lang.Object another)`	This instance is equal to all instances of `BLNexusClientConfiguration` that have equal attribute values.
`int`	`hashCode()`	Computes a hash code from attributes: `applicationVersion`, `userName`, `password`, `stagingProfileId`, `baseURI`.
`java.lang.String`	`password()`
`java.lang.String`	`stagingProfileId()`
`java.lang.String`	`toString()`	Prints the immutable value `BLNexusClientConfiguration` with attribute values.
`java.lang.String`	`userName()`
`BLNexusClientConfiguration`	`withApplicationVersion(BLApplicationVersion value)`	Copy the current immutable object by setting a value for the `applicationVersion` attribute.
`BLNexusClientConfiguration`	`withBaseURI(java.net.URI value)`	Copy the current immutable object by setting a value for the `baseURI` attribute.
`BLNexusClientConfiguration`	`withPassword(java.lang.String value)`	Copy the current immutable object by setting a value for the `password` attribute.
`BLNexusClientConfiguration`	`withStagingProfileId(java.lang.String value)`	Copy the current immutable object by setting a value for the `stagingProfileId` attribute.
`BLNexusClientConfiguration`	`withUserName(java.lang.String value)`	Copy the current immutable object by setting a value for the `userName` attribute.

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

- Method Detail
  - applicationVersion
```
public BLApplicationVersion applicationVersion()
```
    Specified by:
    
    applicationVersion in interface BLNexusClientConfigurationType
    
    Returns:
    
    The application using the client
  - userName
```
public java.lang.String userName()
```
    Specified by:
    
    userName in interface BLNexusClientConfigurationType
    
    Returns:
    
    The Nexus username
  - password
```
public java.lang.String password()
```
    Specified by:
    
    password in interface BLNexusClientConfigurationType
    
    Returns:
    
    The Nexus password
  - stagingProfileId
```
public java.lang.String stagingProfileId()
```
    Specified by:
    
    stagingProfileId in interface BLNexusClientConfigurationType
    
    Returns:
    
    The Nexus staging profile ID
  - baseURI
```
public java.net.URI baseURI()
```
    Specified by:
    
    baseURI in interface BLNexusClientConfigurationType
    
    Returns:
    
    The base URI of the Nexus server
  - withApplicationVersion
```
public final BLNexusClientConfiguration withApplicationVersion(BLApplicationVersion value)
```
    Copy the current immutable object by setting a value for the applicationVersion attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for applicationVersion
    
    Returns:
    
    A modified copy of the this object
  - withUserName
```
public final BLNexusClientConfiguration withUserName(java.lang.String value)
```
    Copy the current immutable object by setting a value for the userName attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for userName
    
    Returns:
    
    A modified copy of the this object
  - withPassword
```
public final BLNexusClientConfiguration withPassword(java.lang.String value)
```
    Copy the current immutable object by setting a value for the password attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for password
    
    Returns:
    
    A modified copy of the this object
  - withStagingProfileId
```
public final BLNexusClientConfiguration withStagingProfileId(java.lang.String value)
```
    Copy the current immutable object by setting a value for the stagingProfileId attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for stagingProfileId
    
    Returns:
    
    A modified copy of the this object
  - withBaseURI
```
public final BLNexusClientConfiguration withBaseURI(java.net.URI value)
```
    Copy the current immutable object by setting a value for the baseURI attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for baseURI
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(java.lang.Object another)
```
    This instance is equal to all instances of BLNexusClientConfiguration that have equal attribute values.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: applicationVersion, userName, password, stagingProfileId, baseURI.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    hashCode value
  - toString
```
public java.lang.String toString()
```
    Prints the immutable value BLNexusClientConfiguration with attribute values.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static BLNexusClientConfiguration copyOf(BLNexusClientConfigurationType instance)
```
    Creates an immutable copy of a BLNexusClientConfigurationType 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 BLNexusClientConfiguration instance
  - builder
```
public static BLNexusClientConfiguration.Builder builder()
```
    Creates a builder for BLNexusClientConfiguration.
    BLNexusClientConfiguration.builder() .setApplicationVersion(com.io7m.brooklime.api.BLApplicationVersion) // required applicationVersion .setUserName(String) // required userName .setPassword(String) // required password .setStagingProfileId(String) // required stagingProfileId .setBaseURI(java.net.URI) // optional baseURI .build();
    Returns:
    
    A new BLNexusClientConfiguration builder

Class BLNexusClientConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

applicationVersion

userName

password

stagingProfileId

baseURI

withApplicationVersion

withUserName

withPassword

withStagingProfileId

withBaseURI

equals

hashCode

toString

copyOf

builder