Package com.io7m.jnoisetype.api
Class NTModulatorIndex
java.lang.Object
com.io7m.jnoisetype.api.NTModulatorIndex
- All Implemented Interfaces:
NTModulatorIndexType
,Comparable<NTModulatorIndexType>
The valid values for modulator indices.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic NTModulatorIndex.Builder
builder()
Creates a builder forNTModulatorIndex
.static NTModulatorIndex
copyOf
(NTModulatorIndexType instance) Creates an immutable copy of aNTModulatorIndexType
value.boolean
This instance is equal to all instances ofNTModulatorIndex
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:value
.static NTModulatorIndex
of
(int value) Construct a new immutableNTModulatorIndex
instance.toString()
Prints the immutable valueNTModulatorIndex
with attribute values.int
value()
final NTModulatorIndex
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.NTModulatorIndexType
asUnsigned16, checkPreconditions, compareTo
-
Method Details
-
value
public int value()- Specified by:
value
in interfaceNTModulatorIndexType
- 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 ofNTModulatorIndex
that have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:value
. -
toString
Prints the immutable valueNTModulatorIndex
with attribute values. -
of
Construct a new immutableNTModulatorIndex
instance.- Parameters:
value
- The value for thevalue
attribute- Returns:
- An immutable NTModulatorIndex instance
-
copyOf
Creates an immutable copy of aNTModulatorIndexType
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 NTModulatorIndex instance
-
builder
Creates a builder forNTModulatorIndex
.NTModulatorIndex.builder() .setValue(int) // required
value
.build();- Returns:
- A new NTModulatorIndex builder
-