net.charlesames.music.musicxml
Class IdentificationEncodingSupport

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

public class IdentificationEncodingSupport
extends MusicXmlEntity

The IdentificationEncodingSupport class implements the MusicXML <supports> 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 IdentificationEncodingSupport	fromXmlNode(org.w3c.dom.Element element, IdentificationEncoding container) Create a new IdentificationEncodingSupport instance and fill it with loaded data.
java.lang.String	getAttribute() Getter for the Attribute property.
IdentificationEncoding	getContainer() Get the parent object.
java.lang.String	getElement() Getter for the Element property.
static IdentificationEncodingSupport	getInstance(IdentificationEncoding container) Create a new IdentificationEncodingSupport instance.
java.lang.String	getSupportType() Getter for the SupportType property.
java.lang.String	getSupportValue() Getter for the SupportValue property.
void	putXmlData(org.w3c.dom.Element element)
void	setAttribute(java.lang.String attribute) Setter for the Attribute property.
void	setElement(java.lang.String element) Setter for the Element property.
void	setSupportType(java.lang.String supportType) Setter for the SupportType property.
void	setSupportValue(java.lang.String supportValue) Setter for the SupportValue 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

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 IdentificationEncodingSupport getInstance(IdentificationEncoding container)

Create a new IdentificationEncodingSupport instance.

Parameters:

container - The IdentificationEncoding which will contain the new IdentificationEncodingSupport instance.

Returns:

The newly created IdentificationEncodingSupport instance.

getContainer

public IdentificationEncoding getContainer()

Description copied from class: MusicXmlEntity

Get the parent object.

Overrides:

getContainer in class MusicXmlEntity

Returns:

The parent object.

getAttribute

public java.lang.String getAttribute()

Getter for the Attribute property.

Returns:

The current Attribute value.

setAttribute

public void setAttribute(java.lang.String attribute)

Setter for the Attribute property.

Parameters:

attribute - The intended Attribute value.

getElement

public java.lang.String getElement()

Getter for the Element property.

Returns:

The current Element value.

setElement

public void setElement(java.lang.String element)

Setter for the Element property.

Parameters:

element - The intended Element value.

getSupportType

public java.lang.String getSupportType()

Getter for the SupportType property.

Returns:

The current SupportType value.

setSupportType

public void setSupportType(java.lang.String supportType)

Setter for the SupportType property.

Parameters:

supportType - The intended SupportType value.

getSupportValue

public java.lang.String getSupportValue()

Getter for the SupportValue property.

Returns:

The current SupportValue value.

setSupportValue

public void setSupportValue(java.lang.String supportValue)

Setter for the SupportValue property.

Parameters:

supportValue - The intended SupportValue value.

fromXmlNode

public static IdentificationEncodingSupport fromXmlNode(org.w3c.dom.Element element,
                                                        IdentificationEncoding container)

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

Parameters:

element - The XML element that provides the IdentificationEncodingSupport data

container - The IdentificationEncoding which will contain the new IdentificationEncodingSupport instance.

Returns:

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