Package com.io7m.jnoisetype.api

Class NTInstrumentIndex

java.lang.Object

com.io7m.jnoisetype.api.NTInstrumentIndex

All Implemented Interfaces:

NTInstrumentIndexType, java.lang.Comparable<NTInstrumentIndexType>

public final class NTInstrumentIndex
extends java.lang.Object
implements NTInstrumentIndexType

The valid values for instrument indices.

Nested Class Summary

Nested Classes

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

Method Summary

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

asUnsigned16, checkPreconditions, compareTo

Method Detail

value

public int value()

Specified by:

value in interface NTInstrumentIndexType

Returns:

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

withValue

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static NTInstrumentIndex of(int value)

Construct a new immutable NTInstrumentIndex instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable NTInstrumentIndex instance

copyOf

public static NTInstrumentIndex copyOf(NTInstrumentIndexType instance)

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

builder

public static NTInstrumentIndex.Builder builder()

Creates a builder for NTInstrumentIndex.

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

Returns:

A new NTInstrumentIndex builder