net.charlesames.music.musicxml
Class Credit

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

public class Credit
extends MusicXmlEntity

The Credit class implements the MusicXML <credit> 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 Credit	fromXmlNode(org.w3c.dom.Element element, MusicXmlScore container) Create a new Credit instance and fill it with loaded data.
CreditWords	getCreditWords() Getter for the CreditWords property.
static Credit	getInstance(MusicXmlScore container) Create a new Credit instance.
int	getPage() Getter for the Page property.
void	putXmlData(org.w3c.dom.Element element)
void	setCreditWords(CreditWords creditWords) Setter for the CreditWords property.
void	setPage(int page) Setter for the Page 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 Credit getInstance(MusicXmlScore container)

Create a new Credit instance.

Parameters:

container - The MusicXmlScore which will contain the new Credit instance.

Returns:

The newly created Credit instance.

getPage

public int getPage()

Getter for the Page property.

Returns:

The current Page value.

setPage

public void setPage(int page)

Setter for the Page property.

Parameters:

page - The intended Page value.

getCreditWords

public CreditWords getCreditWords()

Getter for the CreditWords property.

Returns:

The current CreditWords value.

setCreditWords

public void setCreditWords(CreditWords creditWords)

Setter for the CreditWords property.

Parameters:

creditWords - The intended CreditWords value.

fromXmlNode

public static Credit fromXmlNode(org.w3c.dom.Element element,
                                 MusicXmlScore container)

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

Parameters:

element - The XML element that provides the Credit data

container - The MusicXmlScore which will contain the new Credit instance.

Returns:

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