net.charlesames.music.musicxml.notation
Class Slur

java.lang.Object
  extended by net.charlesames.utility.common.Disposable
      extended by net.charlesames.music.musicxml.MusicXmlEntity
          extended by net.charlesames.music.musicxml.notation.Notation
              extended by net.charlesames.music.musicxml.notation.Slur

public class Slur
extends Notation

The Slur class implements the MusicXML <slur> notation.

Author:
Charles Ames

Method Summary
 boolean equals(MusicXmlEntity other)
          Test if this MusicXML entity has the same content as another object.
static Slur fromXmlNode(org.w3c.dom.Element element, NoteInMeasure container)
          Create a new Slur instance and fill it with loaded data.
static Slur getInstance(NoteInMeasure container)
          Create a new Slur instance.
 StartStop getSlurType()
          Getter for the SlurType property
 void putXmlData(org.w3c.dom.Element element)
           
 void setSlurType(StartStop value)
          Setter for the SlurType 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.notation.Notation
dispose, getContent, getPlacement, setContent, setPlacement
 
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

getInstance

public static Slur getInstance(NoteInMeasure container)
Create a new Slur instance.

Parameters:
container - The NoteInMeasure which will contain the new Slur instance.
Returns:
The newly created Slur instance.

getSlurType

public StartStop getSlurType()
Getter for the SlurType property

Returns:
The current SlurType value.

setSlurType

public void setSlurType(StartStop value)
Setter for the SlurType property

Parameters:
value - The intended SlurType 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 Notation

fromXmlNode

public static Slur fromXmlNode(org.w3c.dom.Element element,
                               NoteInMeasure container)
Create a new Slur instance and fill it with loaded data.

Parameters:
element - The XML element that provides the Slur data
container - The NoteInMeasure which will contain the new Slur instance.
Returns:
The newly created Slur 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 Notation
Parameters:
other - The other object.
Returns:
True if both objects have the same content; false otherwise.