de.flapdoodle.os.common

Class ImmutableOneOf

java.lang.Object

de.flapdoodle.os.common.OneOf

de.flapdoodle.os.common.ImmutableOneOf

All Implemented Interfaces:

Peculiarity

public final class ImmutableOneOf
extends OneOf

Immutable implementation of OneOf.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableOneOf.Builder	builder() Creates a builder for ImmutableOneOf.
static ImmutableOneOf	copyOf(OneOf instance) Creates an immutable copy of a OneOf value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableOneOf that have equal attribute values.
int	hashCode() Computes a hash code from attributes: pecularities.
static ImmutableOneOf	of(Iterable<? extends DistinctPeculiarity<?>> pecularities) Construct a new immutable OneOf instance.
static ImmutableOneOf	of(List<DistinctPeculiarity<?>> pecularities) Construct a new immutable OneOf instance.
List<DistinctPeculiarity<?>>	pecularities()
String	toString() Prints the immutable value OneOf with attribute values.
ImmutableOneOf	withPecularities(DistinctPeculiarity<?>... elements) Copy the current immutable object with elements that replace the content of pecularities.
ImmutableOneOf	withPecularities(Iterable<? extends DistinctPeculiarity<?>> elements) Copy the current immutable object with elements that replace the content of pecularities.

Methods inherited from class de.flapdoodle.os.common.OneOf

check, of

Methods inherited from class java.lang.Object

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

Method Detail

pecularities

public List<DistinctPeculiarity<?>> pecularities()

Specified by:

pecularities in class OneOf

Returns:

The value of the pecularities attribute

withPecularities

@SafeVarargs
public final ImmutableOneOf withPecularities(DistinctPeculiarity<?>... elements)

Copy the current immutable object with elements that replace the content of pecularities.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withPecularities

public final ImmutableOneOf withPecularities(Iterable<? extends DistinctPeculiarity<?>> elements)

Copy the current immutable object with elements that replace the content of pecularities. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of pecularities elements to set

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

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

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value OneOf with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableOneOf of(List<DistinctPeculiarity<?>> pecularities)

Construct a new immutable OneOf instance.

Parameters:

pecularities - The value for the pecularities attribute

Returns:

An immutable OneOf instance

of

public static ImmutableOneOf of(Iterable<? extends DistinctPeculiarity<?>> pecularities)

Construct a new immutable OneOf instance.

Parameters:

pecularities - The value for the pecularities attribute

Returns:

An immutable OneOf instance

copyOf

public static ImmutableOneOf copyOf(OneOf instance)

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

builder

public static ImmutableOneOf.Builder builder()

Creates a builder for ImmutableOneOf.

 ImmutableOneOf.builder()
    .addPecularities|addAllPecularities(de.flapdoodle.os.common.DistinctPeculiarity<?>) // pecularities elements
    .build();
 

Returns:

A new ImmutableOneOf builder