net.charlesames.music.musicxml.notation
Class BreathMark

java.lang.Object
  net.charlesames.utility.common.Disposable
      net.charlesames.music.musicxml.MusicXmlEntity
          net.charlesames.music.musicxml.notation.Notation
              net.charlesames.music.musicxml.notation.Articulation
                  net.charlesames.music.musicxml.notation.BreathMark

public class BreathMark
extends Articulation

The BreathMark class implements the MusicXML <breath-mark> articulation.

Author:

Charles Ames

Constructor Summary

BreathMark(MusicXmlEntity container)
Constructor for new BreathMark instances.

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 BreathMark	fromXmlNode(org.w3c.dom.Element element, MusicXmlEntity container) Create a new BreathMark instance and fill it with loaded data.
static BreathMark	getInstance(TimedEvent container) Create a new BreathMark 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.Articulation

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

BreathMark

public BreathMark(MusicXmlEntity container)

Constructor for new BreathMark instances.

Parameters:

container - The TimedEvent which will contain the new BreathMark instance.

Method Detail

dispose

public void dispose()

Description copied from class: Disposable

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

Overrides:

dispose in class Notation

getInstance

public static BreathMark getInstance(TimedEvent container)

Create a new BreathMark instance.

Parameters:

container - The TimedEvent which will contain the new BreathMark instance.

Returns:

The newly created BreathMark 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 BreathMark fromXmlNode(org.w3c.dom.Element element,
                                     MusicXmlEntity container)

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

Parameters:

element - The XML element that provides the BreathMark data

container - The MusicXmlEntity which will contain the new BreathMark instance.

Returns:

The newly created BreathMark 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 Articulation

Parameters:

other - The other object.

Returns:

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