Package com.io7m.jnoisetype.api

Class NTTransformIndex

java.lang.Object

com.io7m.jnoisetype.api.NTTransformIndex

All Implemented Interfaces:

NTTransformIndexType, java.lang.Comparable<NTTransformIndexType>

public final class NTTransformIndex
extends java.lang.Object
implements NTTransformIndexType

The valid values for transform indices.

Nested Class Summary

Nested Classes

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

Method Summary

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

asUnsigned16, checkPreconditions, compareTo

Method Detail

value

public int value()

Specified by:

value in interface NTTransformIndexType

Returns:

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

withValue

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static NTTransformIndex of(int value)

Construct a new immutable NTTransformIndex instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable NTTransformIndex instance

copyOf

public static NTTransformIndex copyOf(NTTransformIndexType instance)

Creates an immutable copy of a NTTransformIndexType 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 NTTransformIndex instance

builder

public static NTTransformIndex.Builder builder()

Creates a builder for NTTransformIndex.

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

Returns:

A new NTTransformIndex builder