Module com.io7m.jspiel.api

Package com.io7m.jspiel.api

Class RiffChunkID

java.lang.Object

com.io7m.jspiel.api.RiffChunkID

All Implemented Interfaces:

RiffChunkIDType

public final class RiffChunkID
extends java.lang.Object
implements RiffChunkIDType

A FourCC chunk ID.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RiffChunkID.Builder	Builds instances of type RiffChunkID.

Method Summary

Modifier and Type	Method	Description
static RiffChunkID.Builder	builder()	Creates a builder for RiffChunkID.
static RiffChunkID	copyOf(RiffChunkIDType instance)	Creates an immutable copy of a RiffChunkIDType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of RiffChunkID that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: value.
static RiffChunkID	of(java.lang.String value)	Construct a new immutable RiffChunkID instance.
java.lang.String	toString()	Prints the immutable value RiffChunkID with attribute values.
java.lang.String	value()
RiffChunkID	withValue(java.lang.String value)	Copy the current immutable object by setting a value for the value attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.io7m.jspiel.api.RiffChunkIDType

checkPreconditions

Method Detail

value

public java.lang.String value()

Specified by:

value in interface RiffChunkIDType

Returns:

The chunk ID string

withValue

public final RiffChunkID withValue(java.lang.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(java.lang.Object another)

This instance is equal to all instances of RiffChunkID 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: value.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value RiffChunkID with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static RiffChunkID of(java.lang.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