Package com.io7m.jnoisetype.api

Class NTPresetIndex

java.lang.Object

com.io7m.jnoisetype.api.NTPresetIndex

All Implemented Interfaces:

NTPresetIndexType, java.lang.Comparable<NTPresetIndexType>

public final class NTPresetIndex
extends java.lang.Object
implements NTPresetIndexType

The valid values for preset indices.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static NTPresetIndex.Builder	builder()	Creates a builder for NTPresetIndex.
static NTPresetIndex	copyOf(NTPresetIndexType instance)	Creates an immutable copy of a NTPresetIndexType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of NTPresetIndex that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: value.
static NTPresetIndex	of(int value)	Construct a new immutable NTPresetIndex instance.
java.lang.String	toString()	Prints the immutable value NTPresetIndex with attribute values.
int	value()
NTPresetIndex	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.NTPresetIndexType

asUnsigned16, checkPreconditions, compareTo

Method Detail

value

public int value()

Specified by:

value in interface NTPresetIndexType

Returns:

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

withValue

public final NTPresetIndex 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 NTPresetIndex 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 NTPresetIndex with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static NTPresetIndex of(int value)

Construct a new immutable NTPresetIndex instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable NTPresetIndex instance

copyOf

public static NTPresetIndex copyOf(NTPresetIndexType instance)

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

builder

public static NTPresetIndex.Builder builder()

Creates a builder for NTPresetIndex.

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

Returns:

A new NTPresetIndex builder