net.charlesames.music.musicxml.notation
Class Fingering

java.lang.Object
  extended by net.charlesames.utility.common.Disposable
      extended by net.charlesames.music.musicxml.MusicXmlEntity
          extended by net.charlesames.music.musicxml.notation.Notation
              extended by net.charlesames.music.musicxml.notation.TechnicalNotation
                  extended by net.charlesames.music.musicxml.notation.Fingering

public class Fingering
extends TechnicalNotation

The Fingering class implements the MusicXML <fingering> technical notation.

Author:
Charles Ames

Constructor Summary
Fingering(MusicXmlEntity container)
          Constructor for new Fingering instances.
 
Method Summary
 boolean equals(MusicXmlEntity other)
          Test if this MusicXML entity has the same content as another object.
static Fingering fromXmlNode(org.w3c.dom.Element element, MusicXmlEntity container)
          Create a new Fingering instance and fill it with loaded data.
static Fingering getInstance(TimedEvent container)
          Create a new Fingering instance.
 org.w3c.dom.Node toXmlNode(org.w3c.dom.Node parent)
          Serialize the content of a MusicXML entity into an XML element.
 
Methods inherited from class net.charlesames.music.musicxml.notation.TechnicalNotation
dispose, putXmlData
 
Methods inherited from class net.charlesames.music.musicxml.notation.Notation
getContent, getPlacement, setContent, setPlacement
 
Methods inherited from class net.charlesames.music.musicxml.MusicXmlEntity
getContainer, makeDirty
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Fingering

public Fingering(MusicXmlEntity container)
Constructor for new Fingering instances.

Parameters:
container - The TimedEvent which will contain the new Fingering instance.
Method Detail

getInstance

public static Fingering getInstance(TimedEvent container)
Create a new Fingering instance.

Parameters:
container - The TimedEvent which will contain the new Fingering instance.
Returns:
The newly created Fingering instance.

toXmlNode

public org.w3c.dom.Node toXmlNode(org.w3c.dom.Node parent)
Description copied from class: MusicXmlEntity
Serialize the content of a MusicXML entity into an XML element.

Specified by:
toXmlNode in class MusicXmlEntity
Parameters:
parent - The XML element which is to receive the data.
Returns:
The newly created XML element.

fromXmlNode

public static Fingering fromXmlNode(org.w3c.dom.Element element,
                                    MusicXmlEntity container)
Create a new Fingering instance and fill it with loaded data.

Parameters:
element - The XML element that provides the Fingering data
container - The MusicXmlEntity which will contain the new Fingering instance.
Returns:
The newly created Fingering instance.

equals

public boolean equals(MusicXmlEntity other)
Description copied from class: MusicXmlEntity
Test if this MusicXML entity has the same content as another object.

Overrides:
equals in class TechnicalNotation
Parameters:
other - The other object.
Returns:
True if both objects have the same content; false otherwise.