Package com.io7m.jnoisetype.api

Class NTSampleName

java.lang.Object
com.io7m.jnoisetype.api.NTSampleName
All Implemented Interfaces:
NTSampleNameType, java.lang.Comparable<NTSampleNameType>
public final class NTSampleName
extends java.lang.Object
implements NTSampleNameType
See Also:
"SoundFontⓡ Technical Specification 2.04, §7.10 The SHDR subchunk"

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  NTSampleName.Builder
    Builds instances of type NTSampleName.

  • Method Summary

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

    checkPreconditions, compareTo

  • Method Details

    • value

      public java.lang.String value()
      Specified by:
      value in interface NTSampleNameType
      Returns:
      The actual string value

    • withValue

      public final NTSampleName 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 NTSampleName 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 NTSampleName with attribute values.
      Overrides:
      toString in class java.lang.Object
      Returns:
      A string representation of the value

    • of

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

    • copyOf

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

    • builder

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