net.charlesames.music.musicxml
Class Pitch

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

public class Pitch
extends MusicXmlEntity

The Pitch class implements the MusicXML <pitch> 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 Pitch	fromXmlNode(org.w3c.dom.Element element, MusicXmlEntity container) Create a new Pitch instance and fill it with loaded data.
double	getAlter() Getter for the Alter property.
int	getOctave() Getter for the Octave property.
java.lang.String	getStep() Getter for the Step property.
void	putXmlData(org.w3c.dom.Element element)
void	setAlter(double alter) Setter for the Alter property.
void	setOctave(int octave) Setter for the Octave 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

getAlter

public double getAlter()

Getter for the Alter property.

Returns:

The current Alter value.

setAlter

public void setAlter(double alter)

Setter for the Alter property.

Parameters:

alter - The intended Alter value.

fromXmlNode

public static Pitch fromXmlNode(org.w3c.dom.Element element,
                                MusicXmlEntity container)

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

Parameters:

element - The XML element that provides the Pitch data

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

Returns:

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

Parameters:

other - The other object.

Returns:

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

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

getOctave

public int getOctave()

Getter for the Octave property.

Returns:

The current Octave value.

setOctave

public void setOctave(int octave)

Setter for the Octave property.

Parameters:

octave - The intended Octave 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.