Package com.io7m.jspiel.api

Class RiffChunkID

java.lang.Object
com.io7m.jspiel.api.RiffChunkID
All Implemented Interfaces:
RiffChunkIDType
public final class RiffChunkID extends Object implements RiffChunkIDType
A FourCC chunk ID.

  • Method Details

    • value

      public String value()
      Specified by:
      value in interface RiffChunkIDType
      Returns:
      The chunk ID string

    • withValue

      public final RiffChunkID withValue(String value)
      Copy the current immutable object by setting a value for the value attribute. An equals check 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 RiffChunkID 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 RiffChunkID with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • of

      public static RiffChunkID of(String value)
      Construct a new immutable RiffChunkID instance.
      Parameters:
      value - The value for the value attribute
      Returns:
      An immutable RiffChunkID instance

    • copyOf

      public static RiffChunkID copyOf(RiffChunkIDType instance)
      Creates an immutable copy of a RiffChunkIDType 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 RiffChunkID instance

    • builder

      public static RiffChunkID.Builder builder()
      Creates a builder for RiffChunkID. 
       RiffChunkID.builder()
    .setValue(String) // required value
    .build();
      Returns:
      A new RiffChunkID builder