net.charlesames.music.musicxml
Class Barline

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

public class Barline
extends TimedEvent

The Barline class implements the MusicXML <barline> 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 Barline	fromXmlNode(org.w3c.dom.Element element, MusicXmlEntity container) Create a new Barline instance and fill it with loaded data.
BarStyle	getBarStyle() Getter for the BarStyle property
static Barline	getInstance(MusicXmlEntity container) Create a new Barline instance.
RightLeftMiddle	getLocation() Getter for the Location property.
void	putXmlData(org.w3c.dom.Element element)
void	setBarStyle(BarStyle barStyle) Setter for the BarStyle property
void	setLocation(RightLeftMiddle location) Setter for the Location 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 Barline getInstance(MusicXmlEntity container)

Create a new Barline instance.

Parameters:

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

Returns:

The newly created Barline instance.

getLocation

public RightLeftMiddle getLocation()

Getter for the Location property.

Returns:

The current Location value;

setLocation

public void setLocation(RightLeftMiddle location)

Setter for the Location property.

Parameters:

location - The intended Location value.

getBarStyle

public BarStyle getBarStyle()

Getter for the BarStyle property

Returns:

The current BarStyle value.

setBarStyle

public void setBarStyle(BarStyle barStyle)

Setter for the BarStyle property

Parameters:

barStyle - The intended BarStyle value.

fromXmlNode

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

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

Parameters:

element - The XML element that provides the Barline data

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

Returns:

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