Module com.io7m.jspiel.api
Package com.io7m.jspiel.api

Class RiffSize

  • All Implemented Interfaces:
    RiffSizeType
    public final class RiffSize
extends java.lang.Object
implements RiffSizeType
    A (possibly padded) size value.

    • Method Detail

      • size

        public long size()
        Specified by:
        size in interface RiffSizeType
        Returns:
        The raw size value

      • isPadded

        public boolean isPadded()
        Specified by:
        isPadded in interface RiffSizeType
        Returns:
        true if the size value has an extra padding byte

      • withSize

        public final RiffSize withSize​(long value)
        Copy the current immutable object by setting a value for the size attribute. A value equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for size
        Returns:
        A modified copy of the this object

      • withPadded

        public final RiffSize withPadded​(boolean value)
        Copy the current immutable object by setting a value for the padded attribute. A value equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for padded
        Returns:
        A modified copy of the this object

      • equals

        public boolean equals​(java.lang.Object another)
        This instance is equal to all instances of RiffSize 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: size, padded.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        hashCode value

      • toString

        public java.lang.String toString()
        Prints the immutable value RiffSize with attribute values.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of the value

      • of

        public static RiffSize of​(long size,
                          boolean padded)
        Construct a new immutable RiffSize instance.
        Parameters:
        size - The value for the size attribute
        padded - The value for the padded attribute
        Returns:
        An immutable RiffSize instance

      • copyOf

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

      • builder

        public static RiffSize.Builder builder()
        Creates a builder for RiffSize. 
         RiffSize.builder()
    .setSize(long) // required size
    .setPadded(boolean) // required padded
    .build();
        Returns:
        A new RiffSize builder