net.charlesames.music.musicxml
Class TimedEvent

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

Direct Known Subclasses:

Attributes, Barline, Direction, Directive, NoteInMeasure

public abstract class TimedEvent
extends MusicXmlEntity

The TimedEvent class implements functionality shared between MusicXML elements that happen at a specific time point within a measure.

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.
java.lang.String	getComment() Getter for the Comment property.
int	getDefaultX() Getter for the DefaultX property.
int	getDuration() Getter for the Duration property
int	getTime() Getter for the Time property
boolean	isInChord() Getter for the InChord property
void	putXmlData(org.w3c.dom.Element element)
void	setComment(java.lang.String comment) Setter for the Comment property.
void	setDefaultX(int defaultX) Setter for the DefaultX property.
void	setTime(int time) Setter for the Time property

Methods inherited from class net.charlesames.music.musicxml.MusicXmlEntity

getContainer, makeDirty, toXmlNode

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

getDefaultX

public int getDefaultX()

Getter for the DefaultX property.

Returns:

The current DefaultX value.

setDefaultX

public void setDefaultX(int defaultX)

Setter for the DefaultX property.

Parameters:

defaultX - The intended DefaultX value.

getTime

public int getTime()

Getter for the Time property

Returns:

The current Time value.

setTime

public void setTime(int time)

Setter for the Time property

Parameters:

time - The intended Time value.

getComment

public java.lang.String getComment()

Getter for the Comment property.

Returns:

The current Comment value.

setComment

public void setComment(java.lang.String comment)

Setter for the Comment property.

Parameters:

comment - The intended Comment value.

isInChord

public boolean isInChord()

Getter for the InChord property

Returns:

The current InChord value.

getDuration

public int getDuration()

Getter for the Duration property

Returns:

The current Duration value.

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.