Package com.io7m.jnoisetype.api
Class NTSampleIndex
java.lang.Object
com.io7m.jnoisetype.api.NTSampleIndex
- All Implemented Interfaces:
NTSampleIndexType
,Comparable<NTSampleIndexType>
The valid values for sample indices.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic NTSampleIndex.Builder
builder()
Creates a builder forNTSampleIndex
.static NTSampleIndex
copyOf
(NTSampleIndexType instance) Creates an immutable copy of aNTSampleIndexType
value.boolean
This instance is equal to all instances ofNTSampleIndex
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:value
.static NTSampleIndex
of
(int value) Construct a new immutableNTSampleIndex
instance.toString()
Prints the immutable valueNTSampleIndex
with attribute values.int
value()
final NTSampleIndex
withValue
(int value) Copy the current immutable object by setting a value for thevalue
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 Details
-
value
public int value()- Specified by:
value
in interfaceNTSampleIndexType
- Returns:
- The raw value in the range
[0, 0xffff]
-
withValue
Copy the current immutable object by setting a value for thevalue
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for value- Returns:
- A modified copy of the
this
object
-
equals
This instance is equal to all instances ofNTSampleIndex
that have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:value
. -
toString
Prints the immutable valueNTSampleIndex
with attribute values. -
of
Construct a new immutableNTSampleIndex
instance.- Parameters:
value
- The value for thevalue
attribute- Returns:
- An immutable NTSampleIndex instance
-
copyOf
Creates an immutable copy of aNTSampleIndexType
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
Creates a builder forNTSampleIndex
.NTSampleIndex.builder() .setValue(int) // required
value
.build();- Returns:
- A new NTSampleIndex builder
-