Package com.io7m.jnoisetype.api

Class NTModulatorIndex

java.lang.Object

com.io7m.jnoisetype.api.NTModulatorIndex

All Implemented Interfaces:

NTModulatorIndexType, java.lang.Comparable<NTModulatorIndexType>

public final class NTModulatorIndex
extends java.lang.Object
implements NTModulatorIndexType

The valid values for modulator indices.

Nested Class Summary

Nested Classes

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

Method Summary

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

asUnsigned16, checkPreconditions, compareTo

Method Detail

value

public int value()

Specified by:

value in interface NTModulatorIndexType

Returns:

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

withValue

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static NTModulatorIndex of(int value)

Construct a new immutable NTModulatorIndex instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable NTModulatorIndex instance

copyOf

public static NTModulatorIndex copyOf(NTModulatorIndexType instance)

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

builder

public static NTModulatorIndex.Builder builder()

Creates a builder for NTModulatorIndex.

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

Returns:

A new NTModulatorIndex builder