net.charlesames.music.musicxml
Class Directive

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

public class Directive
extends TimedEvent

The Directive class implements the MusicXML <directive> event.

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 Directive	fromXmlNode(org.w3c.dom.Element element, Measure container) Create a new Directive instance and fill it with loaded data.
static Directive	getInstance(MusicXmlEntity container) Create a new Directive instance.
Sound	getSound() Getter for Words property.
int	getStaff() Getter for Staff property.
Words	getWords() Getter for Words property.
void	putXmlData(org.w3c.dom.Element element)
void	setSound(Sound sound) Setter for Sound property.
void	setStaff(int staff) Setter for Staff property.
void	setWords(Words words) Setter for Words 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.TimedEvent

getComment, getDefaultX, getDuration, getTime, isInChord, setComment, setDefaultX, setTime

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.

Overrides:

dispose in class TimedEvent

getInstance

public static Directive getInstance(MusicXmlEntity container)

Create a new Directive instance.

Parameters:

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

Returns:

The newly created Directive instance.

getStaff

public int getStaff()

Getter for Staff property.

Returns:

The current Staff value.

setStaff

public void setStaff(int staff)

Setter for Staff property.

Parameters:

staff - The intended Staff value.

getWords

public Words getWords()

Getter for Words property.

Returns:

The current Words value.

setWords

public void setWords(Words words)

Setter for Words property.

Parameters:

words - The intended Words value.

getSound

public Sound getSound()

Getter for Words property.

Returns:

The current Words value.

setSound

public void setSound(Sound sound)

Setter for Sound property.

Parameters:

sound - The intended Sound value.

fromXmlNode

public static Directive fromXmlNode(org.w3c.dom.Element element,
                                    Measure container)

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

Parameters:

element - The XML element that provides the Directive data

container - The Measure which will contain the new Directive instance.

Returns:

The newly created Directive 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)

Overrides:

putXmlData in class TimedEvent

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 TimedEvent

Parameters:

other - The other object.

Returns:

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