net.charlesames.music.musicxml
Class PedalTuning

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

public class PedalTuning
extends MusicXmlEntity

The PedalTuning class implements the MusicXML <pedal-tuning> 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 PedalTuning	fromXmlNode(org.w3c.dom.Element element, HarpPedals container) Create a new PedalTuning instance and fill it with loaded data.
int	getAlter() Getter for the Alter property.
static PedalTuning	getInstance(HarpPedals container) Create a new PedalTuning instance.
java.lang.String	getStep() Getter for the Step property.
void	putXmlData(org.w3c.dom.Element element)
void	setAlter(int alter) Setter for the Alter property.
void	setStep(java.lang.String step) Setter for the Step property.
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 PedalTuning getInstance(HarpPedals container)

Create a new PedalTuning instance.

Parameters:

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

Returns:

The newly created PedalTuning instance.

getAlter

public int getAlter()

Getter for the Alter property.

Returns:

The current Alter value.

setAlter

public void setAlter(int alter)

Setter for the Alter property.

Parameters:

alter - The intended Alter value.

getStep

public java.lang.String getStep()

Getter for the Step property.

Returns:

The current Step value.

setStep

public void setStep(java.lang.String step)

Setter for the Step property.

Parameters:

step - The intended Step value.

fromXmlNode

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

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

Parameters:

element - The XML element that provides the PedalTuning data

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

Returns:

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