Package name.moore.kevin.ze.XMLdata

Class star

java.lang.Object

name.moore.kevin.ze.XMLdata.XMLbase

name.moore.kevin.ze.XMLdata.star

public class star
extends XMLbase

A star has a unique key eg "Sol", type (a stellar spec ) optional description and may have planets associated with it. XML structure:-

<star key="\Romulus\" spec=\"G\">
 <description/>...
 <star>

Author:

Kevin Moore <dev@kevin.moore.name>

Field Summary

Fields

Modifier and Type	Field	Description
private com.jme3.math.Vector2f	coord	Required element in XML <coord>10,33.1</coord>.
private static String	DEFAULTSPEC
private static org.slf4j.Logger	LOGGER
private reference	spec	Required element in XML <spec>G</spec>.

Fields inherited from class name.moore.kevin.ze.XMLdata.XMLbase

key

Constructor Summary

Constructors

Constructor	Description
star()

Method Summary

Modifier and Type	Method	Description
com.jme3.math.Vector2f	getCoord()
Class	getEntityClass()	Derived classes have to override this and say what class eg engine.class they are.
reference	getSpec()	Derived classes override if they really do want to return a spec reference.
protected Object	readResolve()	Called automatically when loading from XML as part of JDK serialisation.

Methods inherited from class name.moore.kevin.ze.XMLdata.XMLbase

defaultXMLmessage, duplicatedXMLmessage, getDescription, getKey, missingXMLmessage

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

DEFAULTSPEC

private static String DEFAULTSPEC

spec

@ZodiacEntityReference
@XStreamConverter(AttributedValueReferenceConverter.class)
private reference spec

Required element in XML <spec>G</spec>.

This XML element is parsed straight into specification component. This type (specification) of star this is eg type "G" - these specs are handled in starSpec

See Also:

planetSpec

coord

@XStreamConverter(SingleValueVectorConverter.class)
private com.jme3.math.Vector2f coord

Required element in XML <coord>10,33.1</coord>.

Constructor Details

star

public star()

Method Details

getSpec

public reference getSpec()

Description copied from class: XMLbase

Derived classes override if they really do want to return a spec reference.

Overrides:

getSpec in class XMLbase

Returns:

getCoord

public com.jme3.math.Vector2f getCoord()

Returns:

readResolve

protected Object readResolve()

Description copied from class: XMLbase

Called automatically when loading from XML as part of JDK serialisation.

Used to do some validation of that incoming XML by asserting that properties are set and have defaults as required. Output warning messages if a default is applied. Output error messages if a required XML element is missing and return null to indicate an invalid object.

Overrides:

readResolve in class XMLbase

Returns:

null if we can't create a valid object

getEntityClass

public Class getEntityClass()

Description copied from class: XMLbase

Derived classes have to override this and say what class eg engine.class they are. This allows us to use this base class but discover the derived class.

Specified by:

getEntityClass in class XMLbase

Returns: