net.charlesames.music.musicxml
Class Dynamics

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

public class Dynamics
extends DirectionType

The Dynamics class implements the MusicXML <dynamics> 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 Dynamics	fromXmlNode(org.w3c.dom.Element element, Direction container) Create a new Dynamics instance and fill it with loaded data.
static Dynamics	getInstance(Direction container) Create a new Dynamics instance.
java.lang.String	getSymbol() Getter for the Symbol property.
void	putXmlData(org.w3c.dom.Element element)
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.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 Dynamics getInstance(Direction container)

Create a new Dynamics instance.

Parameters:

container - The Direction which will contain the new Dynamics instance.

Returns:

The newly created Dynamics instance.

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 Dynamics fromXmlNode(org.w3c.dom.Element element,
                                   Direction container)

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

Parameters:

element - The XML element that provides the Dynamics data

container - The Direction which will contain the new Dynamics instance.

Returns:

The newly created Dynamics 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 DirectionType

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.