net.sf.freecol.common.model
Class FreeColObject

java.lang.Object
  net.sf.freecol.common.model.FreeColObject

Direct Known Subclasses:

AbstractGoods, AbstractOption, AbstractUnit, AIMain, AIObject, DiplomaticTrade, ExportData, Feature, FreeColGameObject, FreeColGameObjectType, HighScore, LastSale, NationOptions, NationSummary, Scope, StringTemplate, TradeItem, UnitTypeChange

public abstract class FreeColObject
extends java.lang.Object

Field Summary

protected static java.lang.String	ARRAY_SIZE XML tag name for array elements.
private java.lang.String	id Unique identifier of an object
static java.lang.String	ID_ATTRIBUTE
static java.lang.String	ID_ATTRIBUTE_TAG XML tag name for ID attribute.
static int	INFINITY
protected static java.util.logging.Logger	logger
static java.lang.String	NO_ID
protected static java.lang.String	PARTIAL_ATTRIBUTE XML attribute tag to denote partial updates.
private java.beans.PropertyChangeSupport	pcs
private Specification	specification The specification this object uses.
static int	UNDEFINED
protected static java.lang.String	VALUE_TAG XML tag name for value attribute.

Constructor Summary

FreeColObject()

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
void	dumpObject() Debugging tool, dump object XML to System.err.
void	fireIndexedPropertyChange(java.lang.String propertyName, int index, boolean oldValue, boolean newValue)
void	fireIndexedPropertyChange(java.lang.String propertyName, int index, int oldValue, int newValue)
void	fireIndexedPropertyChange(java.lang.String propertyName, int index, java.lang.Object oldValue, java.lang.Object newValue)
void	firePropertyChange(java.beans.PropertyChangeEvent event)
void	firePropertyChange(java.lang.String propertyName, boolean oldValue, boolean newValue)
void	firePropertyChange(java.lang.String propertyName, int oldValue, int newValue)
void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
static boolean	getAttribute(javax.xml.stream.XMLStreamReader in, java.lang.String attributeName, boolean defaultValue) Return an attribute value or the default value.
<T extends java.lang.Enum<T>> T	getAttribute(javax.xml.stream.XMLStreamReader in, java.lang.String attributeName, java.lang.Class<T> returnType, T defaultValue) Return an attribute value or the default value.
float	getAttribute(javax.xml.stream.XMLStreamReader in, java.lang.String attributeName, float defaultValue) Return an attribute value or the default value.
int	getAttribute(javax.xml.stream.XMLStreamReader in, java.lang.String attributeName, int defaultValue) Return an attribute value or the default value.
java.lang.String	getAttribute(javax.xml.stream.XMLStreamReader in, java.lang.String attributeName, java.lang.String defaultValue) Return an attribute value or the default value.
java.lang.String	getId() Get the Id value.
java.beans.PropertyChangeListener[]	getPropertyChangeListeners()
java.beans.PropertyChangeListener[]	getPropertyChangeListeners(java.lang.String propertyName)
Specification	getSpecification() Describe getSpecification method here.
static java.lang.String	getXMLElementTagName() Gets the tag name used to serialize this object, generally the class name starting with a lower case letter.
boolean	hasAbility(java.lang.String id) Describe hasAbility method here.
boolean	hasAttribute(javax.xml.stream.XMLStreamReader in, java.lang.String attributeName) Return an attribute value or the default value.
boolean	hasListeners(java.lang.String propertyName)
protected void	readAttributes(javax.xml.stream.XMLStreamReader in) Reads the attributes of this object from an XML stream.
protected void	readAttributes(javax.xml.stream.XMLStreamReader in, Specification specification) Reads the attributes of this object from an XML stream.
protected void	readChild(javax.xml.stream.XMLStreamReader in) Reads a single child object.
protected void	readChild(javax.xml.stream.XMLStreamReader in, Specification specification) Reads a single child object.
protected void	readChildren(javax.xml.stream.XMLStreamReader in) Reads the children of this object from an XML stream.
protected void	readChildren(javax.xml.stream.XMLStreamReader in, Specification specification) Reads the children of this object from an XML stream.
protected int[]	readFromArrayElement(java.lang.String tagName, javax.xml.stream.XMLStreamReader in, int[] arrayType) Reads an XML-representation of an array.
protected java.lang.String[]	readFromArrayElement(java.lang.String tagName, javax.xml.stream.XMLStreamReader in, java.lang.String[] arrayType) Reads an XML-representation of an array.
protected <T> java.util.List<T>	readFromListElement(java.lang.String tagName, javax.xml.stream.XMLStreamReader in, java.lang.Class<T> type) Reads an XML-representation of a list.
void	readFromXML(javax.xml.stream.XMLStreamReader in) Initializes this object from an XML-representation of this object, unless the PARTIAL_ATTRIBUTE tag is present which indicates a partial update of an existing object.
void	readFromXMLElement(org.w3c.dom.Element element) Initialize this object from an XML-representation of this object.
protected void	readFromXMLImpl(javax.xml.stream.XMLStreamReader in) Initialize this object from an XML-representation of this object.
protected void	readFromXMLImpl(javax.xml.stream.XMLStreamReader in, Specification specification) Initialize this object from an XML-representation of this object.
protected void	readFromXMLPartialImpl(javax.xml.stream.XMLStreamReader in) Updates this object from an XML-representation of this object.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
void	save(java.io.File file) Writes the object to the given file.
void	save(java.io.OutputStream out) Writes the object to the given output stream
protected void	setId(java.lang.String newId) Set the Id value.
protected void	setSpecification(Specification specification) Sets the specification for this object.
void	toXML(javax.xml.stream.XMLStreamWriter out) This method writes an XML-representation of this object to the given stream.
void	toXML(javax.xml.stream.XMLStreamWriter out, Player player, boolean showAll, boolean toSavedGame) This method writes an XML-representation of this object to the given stream.
void	toXML(javax.xml.stream.XMLStreamWriter out, java.lang.String tag) This method writes an XML-representation of this object with a specified tag to the given stream.
org.w3c.dom.Element	toXMLElement(org.w3c.dom.Document document) This method writes an XML-representation of this object to the given stream.
org.w3c.dom.Element	toXMLElement(Player player, org.w3c.dom.Document document) This method writes an XML-representation of this object to the given stream.
org.w3c.dom.Element	toXMLElement(Player player, org.w3c.dom.Document document, boolean showAll, boolean toSavedGame) This method writes an XML-representation of this object to the given stream.
org.w3c.dom.Element	toXMLElement(Player player, org.w3c.dom.Document document, boolean showAll, boolean toSavedGame, java.lang.String[] fields) This method writes an XML-representation of this object to the given stream.
org.w3c.dom.Element	toXMLElementPartial(org.w3c.dom.Document document, java.lang.String... fields) This method writes a partial XML-representation of this object to an element using only the mandatory and specified fields.
protected abstract void	toXMLImpl(javax.xml.stream.XMLStreamWriter out) This method writes an XML-representation of this object to the given stream.
protected void	toXMLPartialImpl(javax.xml.stream.XMLStreamWriter out, java.lang.String[] fields) This method writes a partial XML-representation of this object to the given stream using only the mandatory and specified fields.
void	writeAttribute(javax.xml.stream.XMLStreamWriter out, java.lang.String attributeName, FreeColObject object) Write an ID attribute if object is not null.
protected void	writeAttributes(javax.xml.stream.XMLStreamWriter out) Write the attributes of this object to a stream.
protected void	writeChildren(javax.xml.stream.XMLStreamWriter out) Write the children of this object to a stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static java.util.logging.Logger logger

INFINITY

public static final int INFINITY

See Also:

Constant Field Values

UNDEFINED

public static final int UNDEFINED

See Also:

Constant Field Values

NO_ID

public static final java.lang.String NO_ID

See Also:

Constant Field Values

ID_ATTRIBUTE

public static final java.lang.String ID_ATTRIBUTE

See Also:

Constant Field Values

VALUE_TAG

protected static final java.lang.String VALUE_TAG

XML tag name for value attribute.

See Also:

Constant Field Values

ID_ATTRIBUTE_TAG

public static final java.lang.String ID_ATTRIBUTE_TAG

XML tag name for ID attribute.

See Also:

Constant Field Values

ARRAY_SIZE

protected static final java.lang.String ARRAY_SIZE

XML tag name for array elements.

See Also:

Constant Field Values

PARTIAL_ATTRIBUTE

protected static final java.lang.String PARTIAL_ATTRIBUTE

XML attribute tag to denote partial updates.

See Also:

Constant Field Values

id

private java.lang.String id

Unique identifier of an object

specification

private Specification specification

The specification this object uses. May be null.

pcs

private java.beans.PropertyChangeSupport pcs

Constructor Detail

FreeColObject

public FreeColObject()

Method Detail

getId

public java.lang.String getId()

Get the Id value.

Returns:

a String value

setId

protected void setId(java.lang.String newId)

Set the Id value.

Parameters:

newId - The new Id value.

getSpecification

public Specification getSpecification()

Describe getSpecification method here.

Returns:

a Specification value

setSpecification

protected void setSpecification(Specification specification)

Sets the specification for this object. This method should only ever be used by the object's constructor.

Parameters:

specification - a Specification value

hasAbility

public boolean hasAbility(java.lang.String id)

Describe hasAbility method here.

Parameters:

id - a String value

Returns:

a boolean value

dumpObject

public void dumpObject()

Debugging tool, dump object XML to System.err.

save

public void save(java.io.File file)
          throws java.io.FileNotFoundException

Writes the object to the given file.

Parameters:

file - the save file

Throws:

java.io.FileNotFoundException

save

public void save(java.io.OutputStream out)

Writes the object to the given output stream

Parameters:

out - the OutputStream

toXMLElement

public org.w3c.dom.Element toXMLElement(org.w3c.dom.Document document)

This method writes an XML-representation of this object to the given stream.

Parameters:

document - The Document.

Returns:

An XML-representation of this object.

toXMLElement

public org.w3c.dom.Element toXMLElement(Player player,
                                        org.w3c.dom.Document document)

This method writes an XML-representation of this object to the given stream.

Only attributes visible to the given Player will be added to that representation if showAll is set to false.

Parameters:

player - The Player this XML-representation should be made for, or null if showAll == true.

document - The Document.

Returns:

An XML-representation of this object.

toXMLElement

public org.w3c.dom.Element toXMLElement(Player player,
                                        org.w3c.dom.Document document,
                                        boolean showAll,
                                        boolean toSavedGame)

This method writes an XML-representation of this object to the given stream.

Only attributes visible to the given Player will be added to that representation if showAll is set to false.

Parameters:

player - The Player this XML-representation should be made for, or null if showAll == true.

document - The Document.

showAll - Only attributes visible to player will be added to the representation if showAll is set to false.

toSavedGame - If true then information that is only needed when saving a game is added.

Returns:

An XML-representation of this object.

toXMLElementPartial

public org.w3c.dom.Element toXMLElementPartial(org.w3c.dom.Document document,
                                               java.lang.String... fields)

This method writes a partial XML-representation of this object to an element using only the mandatory and specified fields.

Parameters:

document - The Document.

fields - The fields to write.

Returns:

An XML-representation of this object.

toXMLElement

public org.w3c.dom.Element toXMLElement(Player player,
                                        org.w3c.dom.Document document,
                                        boolean showAll,
                                        boolean toSavedGame,
                                        java.lang.String[] fields)

This method writes an XML-representation of this object to the given stream.

Only attributes visible to the given Player will be added to that representation if showAll is set to false.

Parameters:

player - The Player this XML-representation should be made for, or null if showAll == true.

document - The Document.

showAll - Only attributes visible to player will be added to the representation if showAll is set to false.

toSavedGame - If true then information that is only needed when saving a game is added.

fields - An array of field names, which if non-null indicates this should be a partial write.

Returns:

An XML-representation of this object.

toXML

public void toXML(javax.xml.stream.XMLStreamWriter out)
           throws javax.xml.stream.XMLStreamException

This method writes an XML-representation of this object to the given stream. All attributes will be made visible.

Parameters:

out - The target stream.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.

See Also:

toXML(XMLStreamWriter, Player, boolean, boolean)

toXML

public void toXML(javax.xml.stream.XMLStreamWriter out,
                  java.lang.String tag)
           throws javax.xml.stream.XMLStreamException

This method writes an XML-representation of this object with a specified tag to the given stream. Almost all FreeColObjects end up calling this, and implementing their own write{Attributes,Children} methods which begin by calling their superclass. This allows a clean nesting of the serialization routines throughout the class hierarchy. All attributes will be made visible.

Parameters:

out - The target stream.

tag - The tag to use.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.

writeAttributes

protected void writeAttributes(javax.xml.stream.XMLStreamWriter out)
                        throws javax.xml.stream.XMLStreamException

Write the attributes of this object to a stream. To be overridden by any object that uses the toXML(XMLStreamWriter, String) call.

Parameters:

out - The target stream.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.

writeChildren

protected void writeChildren(javax.xml.stream.XMLStreamWriter out)
                      throws javax.xml.stream.XMLStreamException

Write the children of this object to a stream. To be overridden by any object that has children and uses the toXML(XMLStreamWriter, String) call.

Parameters:

out - The target stream.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.

toXML

public void toXML(javax.xml.stream.XMLStreamWriter out,
                  Player player,
                  boolean showAll,
                  boolean toSavedGame)
           throws javax.xml.stream.XMLStreamException

This method writes an XML-representation of this object to the given stream. Only attributes visible to the given Player will be added to that representation if showAll is set to false.

Parameters:

out - The target stream.

player - The Player this XML-representation should be made for, or null if showAll == true.

showAll - Only attributes visible to player will be added to the representation if showAll is set to false.

toSavedGame - If true then information that is only needed when saving a game is added.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.

toXMLImpl

protected abstract void toXMLImpl(javax.xml.stream.XMLStreamWriter out)
                           throws javax.xml.stream.XMLStreamException

This method writes an XML-representation of this object to the given stream.

Parameters:

out - The target stream.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.

toXMLPartialImpl

protected void toXMLPartialImpl(javax.xml.stream.XMLStreamWriter out,
                                java.lang.String[] fields)
                         throws javax.xml.stream.XMLStreamException

This method writes a partial XML-representation of this object to the given stream using only the mandatory and specified fields. Ideally this would be abstract, but as not all FreeColObject-subtypes need partial updates we provide a non-operating stub here which is to be overridden where needed.

Parameters:

out - The target stream.

fields - The fields to write.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.

readFromXMLElement

public void readFromXMLElement(org.w3c.dom.Element element)

Initialize this object from an XML-representation of this object.

Parameters:

element - An XML-element that will be used to initialize this object.

readFromXML

public void readFromXML(javax.xml.stream.XMLStreamReader in)
                 throws javax.xml.stream.XMLStreamException

Initializes this object from an XML-representation of this object, unless the PARTIAL_ATTRIBUTE tag is present which indicates a partial update of an existing object.

Parameters:

in - The input stream with the XML.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.

readFromArrayElement

protected int[] readFromArrayElement(java.lang.String tagName,
                                     javax.xml.stream.XMLStreamReader in,
                                     int[] arrayType)
                              throws javax.xml.stream.XMLStreamException

Reads an XML-representation of an array.

Parameters:

tagName - The tagname for the Element representing the array.

in - The input stream with the XML.

arrayType - The type of array to be read.

Returns:

The array.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

readFromListElement

protected <T> java.util.List<T> readFromListElement(java.lang.String tagName,
                                                    javax.xml.stream.XMLStreamReader in,
                                                    java.lang.Class<T> type)
                                         throws javax.xml.stream.XMLStreamException

Reads an XML-representation of a list.

Parameters:

tagName - The tagname for the Element representing the array.

in - The input stream with the XML.

type - The type of the items to be added. This type needs to have a constructor accepting a single String.

Returns:

The list.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

readFromArrayElement

protected java.lang.String[] readFromArrayElement(java.lang.String tagName,
                                                  javax.xml.stream.XMLStreamReader in,
                                                  java.lang.String[] arrayType)
                                           throws javax.xml.stream.XMLStreamException

Reads an XML-representation of an array.

Parameters:

tagName - The tagname for the Element representing the array.

in - The input stream with the XML.

arrayType - The type of array to be read.

Returns:

The array.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

hasAttribute

public boolean hasAttribute(javax.xml.stream.XMLStreamReader in,
                            java.lang.String attributeName)

Return an attribute value or the default value.

Parameters:

in - a XMLStreamReader value

attributeName - An attribute name

Returns:

an int value

getAttribute

public int getAttribute(javax.xml.stream.XMLStreamReader in,
                        java.lang.String attributeName,
                        int defaultValue)

Return an attribute value or the default value.

Parameters:

in - a XMLStreamReader value

attributeName - An attribute name

defaultValue - an int value

Returns:

an int value

getAttribute

public <T extends java.lang.Enum<T>> T getAttribute(javax.xml.stream.XMLStreamReader in,
                                                    java.lang.String attributeName,
                                                    java.lang.Class<T> returnType,
                                                    T defaultValue)

Return an attribute value or the default value.

Parameters:

in - a XMLStreamReader value

attributeName - An attribute name

defaultValue - an int value

Returns:

an int value

getAttribute

public float getAttribute(javax.xml.stream.XMLStreamReader in,
                          java.lang.String attributeName,
                          float defaultValue)

Return an attribute value or the default value.

Parameters:

in - a XMLStreamReader value

attributeName - An attribute name

defaultValue - a float value

Returns:

an int value

getAttribute

public static boolean getAttribute(javax.xml.stream.XMLStreamReader in,
                                   java.lang.String attributeName,
                                   boolean defaultValue)

Return an attribute value or the default value.

Parameters:

in - a XMLStreamReader value

attributeName - An attribute name

defaultValue - a boolean value

Returns:

an boolean value

getAttribute

public java.lang.String getAttribute(javax.xml.stream.XMLStreamReader in,
                                     java.lang.String attributeName,
                                     java.lang.String defaultValue)

Return an attribute value or the default value.

Parameters:

in - a XMLStreamReader value

attributeName - An attribute name

defaultValue - an String value

Returns:

an String value

writeAttribute

public void writeAttribute(javax.xml.stream.XMLStreamWriter out,
                           java.lang.String attributeName,
                           FreeColObject object)
                    throws javax.xml.stream.XMLStreamException

Write an ID attribute if object is not null.

Parameters:

out - a XMLStreamWriter value

attributeName - a String value

object - a FreeColObject value

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

readFromXMLImpl

protected void readFromXMLImpl(javax.xml.stream.XMLStreamReader in)
                        throws javax.xml.stream.XMLStreamException

Initialize this object from an XML-representation of this object.

Parameters:

in - The XML input stream.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

readFromXMLImpl

protected void readFromXMLImpl(javax.xml.stream.XMLStreamReader in,
                               Specification specification)
                        throws javax.xml.stream.XMLStreamException

Initialize this object from an XML-representation of this object.

Parameters:

in - The XML input stream.

specification - A Specification to use.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

readAttributes

protected void readAttributes(javax.xml.stream.XMLStreamReader in)
                       throws javax.xml.stream.XMLStreamException

Reads the attributes of this object from an XML stream.

Parameters:

in - The XML input stream.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

readAttributes

protected void readAttributes(javax.xml.stream.XMLStreamReader in,
                              Specification specification)
                       throws javax.xml.stream.XMLStreamException

Reads the attributes of this object from an XML stream.

Parameters:

in - The XML input stream.

specification - A Specification to use.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

readChildren

protected void readChildren(javax.xml.stream.XMLStreamReader in)
                     throws javax.xml.stream.XMLStreamException

Reads the children of this object from an XML stream.

Parameters:

in - The XML input stream.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

readChildren

protected void readChildren(javax.xml.stream.XMLStreamReader in,
                            Specification specification)
                     throws javax.xml.stream.XMLStreamException

Reads the children of this object from an XML stream.

Parameters:

in - The XML input stream.

specification - A Specification to use.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

readChild

protected void readChild(javax.xml.stream.XMLStreamReader in)
                  throws javax.xml.stream.XMLStreamException

Reads a single child object. This method does calls readChild with a null specification parameter.

Parameters:

in - The XML input stream.

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

readChild

protected void readChild(javax.xml.stream.XMLStreamReader in,
                         Specification specification)
                  throws javax.xml.stream.XMLStreamException

Reads a single child object. This method does nothing. Override it if necessary.

Parameters:

in - The XML input stream.

specification - a Specification value

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

readFromXMLPartialImpl

protected void readFromXMLPartialImpl(javax.xml.stream.XMLStreamReader in)
                               throws javax.xml.stream.XMLStreamException

Updates this object from an XML-representation of this object. Ideally this would be abstract, but as not all FreeColObject-subtypes need partial updates we provide a non-operating stub here which is to be overridden where needed.

Parameters:

in - The input stream with the XML.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

fireIndexedPropertyChange

public void fireIndexedPropertyChange(java.lang.String propertyName,
                                      int index,
                                      boolean oldValue,
                                      boolean newValue)

fireIndexedPropertyChange

public void fireIndexedPropertyChange(java.lang.String propertyName,
                                      int index,
                                      int oldValue,
                                      int newValue)

fireIndexedPropertyChange

public void fireIndexedPropertyChange(java.lang.String propertyName,
                                      int index,
                                      java.lang.Object oldValue,
                                      java.lang.Object newValue)

firePropertyChange

public void firePropertyChange(java.beans.PropertyChangeEvent event)

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               boolean oldValue,
                               boolean newValue)

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               int oldValue,
                               int newValue)

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               java.lang.Object oldValue,
                               java.lang.Object newValue)

getPropertyChangeListeners

public java.beans.PropertyChangeListener[] getPropertyChangeListeners()

getPropertyChangeListeners

public java.beans.PropertyChangeListener[] getPropertyChangeListeners(java.lang.String propertyName)

hasListeners

public boolean hasListeners(java.lang.String propertyName)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

getXMLElementTagName

public static java.lang.String getXMLElementTagName()

Gets the tag name used to serialize this object, generally the class name starting with a lower case letter. This method should be overridden by all subclasses that need to be serialized.

Returns:

null.