net.charlesames.music.musicxml
Class StaffLayout

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

public class StaffLayout
extends MusicXmlEntity

The StaffLayout class implements the MusicXML <staff-layout> 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 StaffLayout	fromXmlNode(org.w3c.dom.Element element, MusicXmlEntity container) Create a new StaffLayout instance and fill it with loaded data.
static StaffLayout	getInstance(MusicXmlEntity container) Create a new StaffLayout instance.
int	getStaffDistance() Getter for the StaffDistance property
void	putXmlData(org.w3c.dom.Element element)
void	setStaffDistance(int staffDistance) Setter for the StaffDistance 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 StaffLayout getInstance(MusicXmlEntity container)

Create a new StaffLayout instance.

Parameters:

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

Returns:

The newly created StaffLayout instance.

getStaffDistance

public int getStaffDistance()

Getter for the StaffDistance property

Returns:

The current StaffDistance value.

setStaffDistance

public void setStaffDistance(int staffDistance)

Setter for the StaffDistance property

Parameters:

staffDistance - The intended StaffDistance value.

fromXmlNode

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

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

Parameters:

element - The XML element that provides the StaffLayout data

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

Returns:

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