net.charlesames.music.musicxml
Class HarpPedals

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

public class HarpPedals
extends DirectionType

The HarpPedals class implements the MusicXML <harp-pedals> direction type.

Author:

Charles Ames

Method Summary

void	addTuning(java.lang.String step, int alter) Add a PedalTuning instance with the indicated step and alter.
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 HarpPedals	fromXmlNode(org.w3c.dom.Element element, Direction container) Create a new HarpPedals instance and fill it with loaded data.
static HarpPedals	getInstance(Direction container) Create a new HarpPedals 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.DirectionType

getContent, getDefaultY, getFontFamily, getFontSize, getFontStyle, getFontWeight, getRelativeX, setContent, setDefaultY, setFontFamily, setFontSize, setFontStyle, setFontWeight, setRelativeX

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.

Overrides:

dispose in class DirectionType

getInstance

public static HarpPedals getInstance(Direction container)

Create a new HarpPedals instance.

Parameters:

container - The Direction which will contain the new HarpPedals instance.

Returns:

The newly created HarpPedals instance.

fromXmlNode

public static HarpPedals fromXmlNode(org.w3c.dom.Element element,
                                     Direction container)

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

Parameters:

element - The XML element that provides the HarpPedals data

container - The Direction which will contain the new HarpPedals instance.

Returns:

The newly created HarpPedals instance.

addTuning

public void addTuning(java.lang.String step,
                      int alter)

Add a PedalTuning instance with the indicated step and alter.

Parameters:

step - The scale step.

alter - The accidental: -1 flat, 0 natural, 1 sharp

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)

Overrides:

putXmlData in class DirectionType

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 DirectionType

Parameters:

other - The other object.

Returns:

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