Package com.io7m.jnoisetype.api

Class NTSampleIndex

java.lang.Object

com.io7m.jnoisetype.api.NTSampleIndex

All Implemented Interfaces:

NTSampleIndexType, java.lang.Comparable<NTSampleIndexType>

public final class NTSampleIndex
extends java.lang.Object
implements NTSampleIndexType

The valid values for sample indices.

Nested Class Summary

Nested Classes

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

Method Summary

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

asUnsigned16, checkPreconditions, compareTo

Method Detail

value

public int value()

Specified by:

value in interface NTSampleIndexType

Returns:

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

withValue

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static NTSampleIndex of(int value)

Construct a new immutable NTSampleIndex instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable NTSampleIndex instance

copyOf

public static NTSampleIndex copyOf(NTSampleIndexType instance)

Creates an immutable copy of a NTSampleIndexType 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 NTSampleIndex instance

builder

public static NTSampleIndex.Builder builder()

Creates a builder for NTSampleIndex.

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

Returns:

A new NTSampleIndex builder