Package com.io7m.jnoisetype.api

Class NTSampleIndex

java.lang.Object
com.io7m.jnoisetype.api.NTSampleIndex
All Implemented Interfaces:
NTSampleIndexType, Comparable<NTSampleIndexType>
public final class NTSampleIndex extends Object implements NTSampleIndexType
The valid values for sample indices.

  • Method Details

    • 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(Object another)
      This instance is equal to all instances of NTSampleIndex that have equal attribute values.
      Overrides:
      equals in class 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 Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value NTSampleIndex with attribute values.
      Overrides:
      toString in class 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