de.flapdoodle.os

Class ImmutablePlatform

java.lang.Object

de.flapdoodle.os.ImmutablePlatform

All Implemented Interfaces:

Platform

public final class ImmutablePlatform
extends Object
implements Platform

Immutable implementation of Platform.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
Architecture	architecture()
static ImmutablePlatform.Builder	builder() Creates a builder for ImmutablePlatform.
static ImmutablePlatform	copyOf(Platform instance) Creates an immutable copy of a Platform value.
Optional<Distribution>	distribution()
boolean	equals(Object another) This instance is equal to all instances of ImmutablePlatform that have equal attribute values.
int	hashCode() Computes a hash code from attributes: operatingSystem, architecture, distribution, version.
OS	operatingSystem()
String	toString() Prints the immutable value Platform with attribute values.
Optional<Version>	version()
ImmutablePlatform	withArchitecture(Architecture value) Copy the current immutable object by setting a value for the architecture attribute.
ImmutablePlatform	withDistribution(Distribution value) Copy the current immutable object by setting a present value for the optional distribution attribute.
ImmutablePlatform	withDistribution(Optional<? extends Distribution> optional) Copy the current immutable object by setting an optional value for the distribution attribute.
ImmutablePlatform	withOperatingSystem(OS value) Copy the current immutable object by setting a value for the operatingSystem attribute.
ImmutablePlatform	withVersion(Optional<? extends Version> optional) Copy the current immutable object by setting an optional value for the version attribute.
ImmutablePlatform	withVersion(Version value) Copy the current immutable object by setting a present value for the optional version attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.os.Platform

detect, detect, detectArchitecture, detectDistribution, detectOS, detectVersion, detectVersion

Method Detail

operatingSystem

public OS operatingSystem()

Specified by:

operatingSystem in interface Platform

Returns:

The value of the operatingSystem attribute

architecture

public Architecture architecture()

Specified by:

architecture in interface Platform

Returns:

The value of the architecture attribute

distribution

public Optional<Distribution> distribution()

Specified by:

distribution in interface Platform

Returns:

The value of the distribution attribute

version

public Optional<Version> version()

Specified by:

version in interface Platform

Returns:

The value of the version attribute

withOperatingSystem

public final ImmutablePlatform withOperatingSystem(OS value)

Copy the current immutable object by setting a value for the operatingSystem attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for operatingSystem

Returns:

A modified copy of the this object

withArchitecture

public final ImmutablePlatform withArchitecture(Architecture value)

Copy the current immutable object by setting a value for the architecture attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for architecture

Returns:

A modified copy of the this object

withDistribution

public final ImmutablePlatform withDistribution(Distribution value)

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

Parameters:

value - The value for distribution

Returns:

A modified copy of this object

withDistribution

public final ImmutablePlatform withDistribution(Optional<? extends Distribution> optional)

Copy the current immutable object by setting an optional value for the distribution 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 distribution

Returns:

A modified copy of this object

withVersion

public final ImmutablePlatform withVersion(Version value)

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

Parameters:

value - The value for version

Returns:

A modified copy of this object

withVersion

public final ImmutablePlatform withVersion(Optional<? extends Version> optional)

Copy the current immutable object by setting an optional value for the version 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 version

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutablePlatform 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: operatingSystem, architecture, distribution, version.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Platform with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutablePlatform copyOf(Platform instance)

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

builder

public static ImmutablePlatform.Builder builder()

Creates a builder for ImmutablePlatform.

 ImmutablePlatform.builder()
    .operatingSystem(de.flapdoodle.os.OS) // required operatingSystem
    .architecture(de.flapdoodle.os.Architecture) // required architecture
    .distribution(de.flapdoodle.os.Distribution) // optional distribution
    .version(de.flapdoodle.os.Version) // optional version
    .build();
 

Returns:

A new ImmutablePlatform builder