net.charlesames.music.musicxml
Class Dashes

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

public class Dashes
extends DirectionType

The Dashes class implements the MusicXML <dashes> direction type.

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 Dashes	fromXmlNode(org.w3c.dom.Element element, MusicXmlEntity container) Create a new Dashes instance and fill it with loaded data.
StartStop	getDashesType() Getter for the DashesType property
static Dashes	getInstance(MusicXmlEntity container) Create a new Dashes instance.
int	getNumber() Getter for the Number property.
void	putXmlData(org.w3c.dom.Element element)
void	setDashesType(StartStop dashesType) Setter for the DashesType property.
void	setNumber(int number) Setter for the Number 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.DirectionType

getContent, getDefaultY, getFontFamily, getFontSize, getFontStyle, getFontWeight, getRelativeX, setContent, setDefaultY, setFontFamily, setFontSize, setFontStyle, setFontWeight, setRelativeX

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 DirectionType

getInstance

public static Dashes getInstance(MusicXmlEntity container)

Create a new Dashes instance.

Parameters:

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

Returns:

The newly created Dashes instance.

getNumber

public int getNumber()

Getter for the Number property.

Returns:

The current Number value.

setNumber

public void setNumber(int number)

Setter for the Number property.

Parameters:

number - The intended Number value.

getDashesType

public StartStop getDashesType()

Getter for the DashesType property

Returns:

The current DashesType value.

setDashesType

public void setDashesType(StartStop dashesType)

Setter for the DashesType property.

Parameters:

dashesType - The intended DashesType value.

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 DirectionType

fromXmlNode

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

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

Parameters:

element - The XML element that provides the Dashes data

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

Returns:

The newly created Dashes instance.

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 DirectionType

Parameters:

other - The other object.

Returns:

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