net.charlesames.music.musicxml
Class IdentificationEncoding

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

public class IdentificationEncoding
extends MusicXmlEntity

The IdentificationEncoding class implements the MusicXML <encoding> element.

Author:

Charles Ames

Method Summary

void	addSoftware(java.lang.String value) Add a new String naming software
void	addSupport(java.lang.String attribute, java.lang.String element, java.lang.String supportType, java.lang.String supportValue) Add a new IdentificationEncodingSupport instance with the indicated parameters.
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 IdentificationEncoding	fromXmlNode(org.w3c.dom.Element element, Identification container) Create a new IdentificationEncoding instance and fill it with loaded data.
Identification	getContainer() Get the parent object.
java.util.Date	getEncodingDate() Getter for the EncodingDate property.
static IdentificationEncoding	getInstance(Identification container) Create a new IdentificationEncoding instance.
java.util.List<java.lang.String>	getSoftware() Get all software.
void	putXmlData(org.w3c.dom.Element element)
void	setEncodingDate(java.util.Date encodingDate) Setter for the EncodingDate 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 IdentificationEncoding getInstance(Identification container)

Create a new IdentificationEncoding instance.

Parameters:

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

Returns:

The newly created IdentificationEncoding instance.

getContainer

public Identification getContainer()

Description copied from class: MusicXmlEntity

Get the parent object.

Overrides:

getContainer in class MusicXmlEntity

Returns:

The parent object.

getEncodingDate

public java.util.Date getEncodingDate()

Getter for the EncodingDate property.

Returns:

The current EncodingDate value.

setEncodingDate

public void setEncodingDate(java.util.Date encodingDate)

Setter for the EncodingDate property.

Parameters:

encodingDate - The intended EncodingDate value.

getSoftware

public java.util.List<java.lang.String> getSoftware()

Get all software.

Returns:

An unsorted collection of Strings.

addSoftware

public void addSoftware(java.lang.String value)

Add a new String naming software

Parameters:

value - The software name.

addSupport

public void addSupport(java.lang.String attribute,
                       java.lang.String element,
                       java.lang.String supportType,
                       java.lang.String supportValue)

Add a new IdentificationEncodingSupport instance with the indicated parameters.

Parameters:

attribute - The attribute

element - The element

supportType - The support type

supportValue - The support value

fromXmlNode

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

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

Parameters:

element - The XML element that provides the IdentificationEncoding data

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

Returns:

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