Package com.io7m.jade.spi

Class ApplicationDirectoryConfiguration

java.lang.Object

com.io7m.jade.spi.ApplicationDirectoryConfiguration

All Implemented Interfaces:

ApplicationDirectoryConfigurationType

public final class ApplicationDirectoryConfiguration
extends java.lang.Object
implements ApplicationDirectoryConfigurationType

The type of application directory configurations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApplicationDirectoryConfiguration.Builder	Builds instances of type ApplicationDirectoryConfiguration.

Method Summary

Modifier and Type	Method	Description
java.lang.String	applicationName()	The name of the application.
static ApplicationDirectoryConfiguration.Builder	builder()	Creates a builder for ApplicationDirectoryConfiguration.
static ApplicationDirectoryConfiguration	copyOf(ApplicationDirectoryConfigurationType instance)	Creates an immutable copy of a ApplicationDirectoryConfigurationType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of ApplicationDirectoryConfiguration that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: applicationName, portablePropertyName.
java.util.Optional<java.lang.String>	portablePropertyName()	The name of a system property which, if present, will be used to enable portable mode.
java.lang.String	toString()	Prints the immutable value ApplicationDirectoryConfiguration with attribute values.
ApplicationDirectoryConfiguration	withApplicationName(java.lang.String value)	Copy the current immutable object by setting a value for the applicationName attribute.
ApplicationDirectoryConfiguration	withPortablePropertyName(java.lang.String value)	Copy the current immutable object by setting a present value for the optional portablePropertyName attribute.
ApplicationDirectoryConfiguration	withPortablePropertyName(java.util.Optional<java.lang.String> optional)	Copy the current immutable object by setting an optional value for the portablePropertyName attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.io7m.jade.spi.ApplicationDirectoryConfigurationType

checkPreconditions

Method Detail

applicationName

public java.lang.String applicationName()

The name of the application. The name is used in paths and must be valid according to ApplicationNames.isValid(String).

Specified by:

applicationName in interface ApplicationDirectoryConfigurationType

Returns:

The name of the application.

portablePropertyName

public java.util.Optional<java.lang.String> portablePropertyName()

The name of a system property which, if present, will be used to enable portable mode. If the system property is present, and can be parsed as a true value, then portable mode will be enabled and all calculated application paths will be relative to the application's working directory.

Specified by:

portablePropertyName in interface ApplicationDirectoryConfigurationType

Returns:

A property name to enable portable mode

withApplicationName

public final ApplicationDirectoryConfiguration withApplicationName(java.lang.String value)

Copy the current immutable object by setting a value for the applicationName attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for applicationName

Returns:

A modified copy of the this object

withPortablePropertyName

public final ApplicationDirectoryConfiguration withPortablePropertyName(java.lang.String value)

Copy the current immutable object by setting a present value for the optional portablePropertyName attribute.

Parameters:

value - The value for portablePropertyName

Returns:

A modified copy of this object

withPortablePropertyName

public final ApplicationDirectoryConfiguration withPortablePropertyName(java.util.Optional<java.lang.String> optional)

Copy the current immutable object by setting an optional value for the portablePropertyName attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.

Parameters:

optional - A value for portablePropertyName

Returns:

A modified copy of this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of ApplicationDirectoryConfiguration 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: applicationName, portablePropertyName.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value ApplicationDirectoryConfiguration with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

copyOf

public static ApplicationDirectoryConfiguration copyOf(ApplicationDirectoryConfigurationType instance)

Creates an immutable copy of a ApplicationDirectoryConfigurationType 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 ApplicationDirectoryConfiguration instance

builder

public static ApplicationDirectoryConfiguration.Builder builder()

Creates a builder for ApplicationDirectoryConfiguration.

 ApplicationDirectoryConfiguration.builder()
    .setApplicationName(String) // required applicationName
    .setPortablePropertyName(String) // optional portablePropertyName
    .build();
 

Returns:

A new ApplicationDirectoryConfiguration builder