de.flapdoodle.os.common.attributes

Class ImmutableSystemProperty

java.lang.Object

de.flapdoodle.os.common.attributes.ImmutableSystemProperty

All Implemented Interfaces:

Attribute<String>, SystemProperty

public final class ImmutableSystemProperty
extends Object
implements SystemProperty

Immutable implementation of SystemProperty.

Use the builder to create immutable instances: ImmutableSystemProperty.builder(). Use the static factory method to create immutable instances: ImmutableSystemProperty.of().

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableSystemProperty.Builder	builder() Creates a builder for ImmutableSystemProperty.
static ImmutableSystemProperty	copyOf(SystemProperty instance) Creates an immutable copy of a SystemProperty value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableSystemProperty that have equal attribute values.
int	hashCode() Computes a hash code from attributes: name.
String	name()
static ImmutableSystemProperty	of(String name) Construct a new immutable SystemProperty instance.
String	toString() Prints the immutable value SystemProperty with attribute values.
ImmutableSystemProperty	withName(String value) Copy the current immutable object by setting a value for the name attribute.

Methods inherited from class java.lang.Object

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

Method Detail

name

public String name()

Specified by:

name in interface SystemProperty

Returns:

The value of the name attribute

withName

public final ImmutableSystemProperty withName(String value)

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

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableSystemProperty 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: name.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value SystemProperty with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableSystemProperty of(String name)

Construct a new immutable SystemProperty instance.

Parameters:

name - The value for the name attribute

Returns:

An immutable SystemProperty instance

copyOf

public static ImmutableSystemProperty copyOf(SystemProperty instance)

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

builder

public static ImmutableSystemProperty.Builder builder()

Creates a builder for ImmutableSystemProperty.

 ImmutableSystemProperty.builder()
    .name(String) // required name
    .build();
 

Returns:

A new ImmutableSystemProperty builder