Package com.io7m.jnoisetype.api

Class NTBankIndex

java.lang.Object

com.io7m.jnoisetype.api.NTBankIndex

All Implemented Interfaces:

NTBankIndexType, java.lang.Comparable<NTBankIndexType>

public final class NTBankIndex
extends java.lang.Object
implements NTBankIndexType

The valid values for bank indices.

Nested Class Summary

Nested Classes

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

Method Summary

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

asUnsigned16, checkPreconditions, compareTo

Method Detail

value

public int value()

Specified by:

value in interface NTBankIndexType

Returns:

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

withValue

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static NTBankIndex of(int value)

Construct a new immutable NTBankIndex instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable NTBankIndex instance

copyOf

public static NTBankIndex copyOf(NTBankIndexType instance)

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

builder

public static NTBankIndex.Builder builder()

Creates a builder for NTBankIndex.

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

Returns:

A new NTBankIndex builder