Package com.io7m.jnoisetype.api

Class NTGeneratorIndex

java.lang.Object

com.io7m.jnoisetype.api.NTGeneratorIndex

All Implemented Interfaces:

NTGeneratorIndexType, java.lang.Comparable<NTGeneratorIndexType>

public final class NTGeneratorIndex
extends java.lang.Object
implements NTGeneratorIndexType

The valid values for generator indices.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.jnoisetype.api.NTGeneratorIndexType

asUnsigned16, checkPreconditions, compareTo

Method Detail

value

public int value()

Specified by:

value in interface NTGeneratorIndexType

Returns:

The raw value in the range [0, 0xffff]

withValue

public final NTGeneratorIndex withValue(int value)

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

Parameters:

value - A new value for value

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

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

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value NTGeneratorIndex with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static NTGeneratorIndex of(int value)

Construct a new immutable NTGeneratorIndex instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable NTGeneratorIndex instance

copyOf

public static NTGeneratorIndex copyOf(NTGeneratorIndexType instance)

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

builder

public static NTGeneratorIndex.Builder builder()

Creates a builder for NTGeneratorIndex.

 NTGeneratorIndex.builder()
    .setValue(int) // required value
    .build();
 

Returns:

A new NTGeneratorIndex builder