net.charlesames.music.musicxml
Class TimeSignature

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

public class TimeSignature
extends MusicXmlEntity

The TimeSignature class implements the MusicXML <time> 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 TimeSignature	fromXmlNode(org.w3c.dom.Element element, Attributes container) Create a new TimeSignature instance and fill it with loaded data.
int	getBeats() Getter for the Beats property
int	getBeatType() Getter for the BeatType property
static TimeSignature	getInstance(Attributes container) Create a new TimeSignature instance.
java.lang.String	getSymbol() Getter for the Symbol property.
void	putXmlData(org.w3c.dom.Element element)
void	setBeats(int beats) Setter for the Beats property
void	setBeatType(int beatType) Setter for the BeatType property
void	setSymbol(java.lang.String symbol) Setter for the Symbol 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 TimeSignature getInstance(Attributes container)

Create a new TimeSignature instance.

Parameters:

container - The Attributes which will contain the new TimeSignature instance.

Returns:

The newly created TimeSignature instance.

getBeats

public int getBeats()

Getter for the Beats property

Returns:

The current Beats value.

setBeats

public void setBeats(int beats)

Setter for the Beats property

Parameters:

beats - The intended Beats value.

getBeatType

public int getBeatType()

Getter for the BeatType property

Returns:

The current BeatType value.

setBeatType

public void setBeatType(int beatType)

Setter for the BeatType property

Parameters:

beatType - The intended BeatType value.

getSymbol

public java.lang.String getSymbol()

Getter for the Symbol property.

Returns:

The current Symbol value.

setSymbol

public void setSymbol(java.lang.String symbol)

Setter for the Symbol property.

Parameters:

symbol - The intended Symbol value.

fromXmlNode

public static TimeSignature fromXmlNode(org.w3c.dom.Element element,
                                        Attributes container)

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

Parameters:

element - The XML element that provides the TimeSignature data

container - The Attributes which will contain the new TimeSignature instance.

Returns:

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