Package com.io7m.jnoisetype.api

Class NTShortString

java.lang.Object

com.io7m.jnoisetype.api.NTShortString

All Implemented Interfaces:

NTShortStringType, java.lang.Comparable<NTShortStringType>

public final class NTShortString
extends java.lang.Object
implements NTShortStringType

See Also:

"SoundFontⓡ Technical Specification 2.04, §5 The INFO-list Chunk"

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static NTShortString.Builder	builder()	Creates a builder for NTShortString.
static NTShortString	copyOf(NTShortStringType instance)	Creates an immutable copy of a NTShortStringType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of NTShortString that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: value.
static NTShortString	of(java.lang.String value)	Construct a new immutable NTShortString instance.
java.lang.String	toString()	Prints the immutable value NTShortString with attribute values.
java.lang.String	value()
NTShortString	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.jnoisetype.api.NTShortStringType

checkPreconditions, compareTo

Method Detail

value

public java.lang.String value()

Specified by:

value in interface NTShortStringType

Returns:

The actual string value

withValue

public final NTShortString 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 NTShortString 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 NTShortString with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static NTShortString of(java.lang.String value)

Construct a new immutable NTShortString instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable NTShortString instance

copyOf

public static NTShortString copyOf(NTShortStringType instance)

Creates an immutable copy of a NTShortStringType 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 NTShortString instance

builder

public static NTShortString.Builder builder()

Creates a builder for NTShortString.

 NTShortString.builder()
    .setValue(String) // required value
    .build();
 

Returns:

A new NTShortString builder