net.charlesames.music.musicxml
Class KeySignature

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

public class KeySignature
extends MusicXmlEntity

The KeySignature class implements the MusicXML <key> 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 KeySignature	fromXmlNode(org.w3c.dom.Element element, MusicXmlEntity container) Create a new KeySignature instance and fill it with loaded data.
int	getFifths() Getter for the Fifths property
static KeySignature	getInstance(MusicXmlEntity container) Create a new KeySignature instance.
Mode	getMode() Getter for the Mode property
void	putXmlData(org.w3c.dom.Element element)
void	setFifths(int fifths) Setter for the Fifths property.
void	setMode(Mode mode) Setter for the Mode 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 KeySignature getInstance(MusicXmlEntity container)

Create a new KeySignature instance.

Parameters:

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

Returns:

The newly created KeySignature instance.

getFifths

public int getFifths()

Getter for the Fifths property

Returns:

The current Fifths value.

setFifths

public void setFifths(int fifths)

Setter for the Fifths property.

Parameters:

fifths - The intended Fifths value.

getMode

public Mode getMode()

Getter for the Mode property

Returns:

The current Mode value.

setMode

public void setMode(Mode mode)

Setter for the Mode property.

Parameters:

mode - The intended Mode value.

fromXmlNode

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

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

Parameters:

element - The XML element that provides the KeySignature data

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

Returns:

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