net.charlesames.music.musicxml
Class Stem

java.lang.Object
  net.charlesames.utility.common.Disposable
      net.charlesames.music.musicxml.MusicXmlEntity
          net.charlesames.music.musicxml.Stem

public class Stem
extends MusicXmlEntity

The Stem class implements the MusicXML <stem> element.

Author:

Charles Ames

Method Summary

void	dispose() Release resources engaged by this object, thus rendering it amenable to garbage collection.
boolean	equals(MusicXmlEntity other) Test if this MusicXML entity has the same content as another object.
static Stem	fromXmlNode(org.w3c.dom.Element element, NoteInMeasure container) Create a new Stem instance and fill it with loaded data.
static Stem	getInstance(NoteInMeasure container) Create a new Stem instance.
void	putXmlData(org.w3c.dom.Element element)
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.MusicXmlEntity

getContainer, makeDirty

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

dispose

public void dispose()

Description copied from class: Disposable

Release resources engaged by this object, thus rendering it amenable to garbage collection.

Specified by:

dispose in class Disposable

getInstance

public static Stem getInstance(NoteInMeasure container)

Create a new Stem instance.

Parameters:

container - The NoteInMeasure which will contain the new Stem instance.

Returns:

The newly created Stem instance.

fromXmlNode

public static Stem fromXmlNode(org.w3c.dom.Element element,
                               NoteInMeasure container)

Create a new Stem instance and fill it with loaded data.

Parameters:

element - The XML element that provides the Stem data

container - The NoteInMeasure which will contain the new Stem instance.

Returns:

The newly created Stem 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.

putXmlData

public void putXmlData(org.w3c.dom.Element element)

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 MusicXmlEntity

Parameters:

other - The other object.

Returns:

True if both objects have the same content; false otherwise.