Package com.io7m.jnoisetype.api

Class NTInstrumentName

java.lang.Object

com.io7m.jnoisetype.api.NTInstrumentName

All Implemented Interfaces:

NTInstrumentNameType, java.lang.Comparable<NTInstrumentNameType>

public final class NTInstrumentName
extends java.lang.Object
implements NTInstrumentNameType

See Also:

"SoundFontⓡ Technical Specification 2.04, §7.6 The SHDR subchunk"

Nested Class Summary

Nested Classes

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

Method Summary

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

checkPreconditions, compareTo

Method Detail

value

public java.lang.String value()

Specified by:

value in interface NTInstrumentNameType

Returns:

The actual string value

withValue

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

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

Construct a new immutable NTInstrumentName instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable NTInstrumentName instance

copyOf

public static NTInstrumentName copyOf(NTInstrumentNameType instance)

Creates an immutable copy of a NTInstrumentNameType 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 NTInstrumentName instance

builder

public static NTInstrumentName.Builder builder()

Creates a builder for NTInstrumentName.

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

Returns:

A new NTInstrumentName builder