net.charlesames.music.musicxml
Class Beam

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

public class Beam
extends MusicXmlEntity

The Beam class implements the MusicXML <beam> 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 Beam	fromXmlNode(org.w3c.dom.Element element, NoteInMeasure container) Create a new Beam instance and fill it with loaded data.
BeamValue	getContent() Getter for the Content property.
static Beam	getInstance(NoteInMeasure container) Create a new Beam instance.
int	getNumber() Getter for the Number property.
void	putXmlData(org.w3c.dom.Element element)
void	setContent(BeamValue content) Setter for the Content 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.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 Beam getInstance(NoteInMeasure container)

Create a new Beam instance.

Parameters:

container - The NoteInMeasure which will contain the new Beam instance.

Returns:

The newly created Beam instance.

getNumber

public int getNumber()

Getter for the Number property.

Returns:

The assigned Number value.

setNumber

public void setNumber(int number)

Setter for the Number property.

Parameters:

number - The intended Number value.

getContent

public BeamValue getContent()

Getter for the Content property.

Returns:

The assigned Content value.

setContent

public void setContent(BeamValue content)

Setter for the Content property.

Parameters:

content - The intended Content value.

fromXmlNode

public static Beam fromXmlNode(org.w3c.dom.Element element,
                               NoteInMeasure container)

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

Parameters:

element - The XML element that provides the Beam data

container - The NoteInMeasure which will contain the new Beam instance.

Returns:

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