Package name.moore.kevin.ze.XMLdata

Class shipyard

java.lang.Object

name.moore.kevin.ze.XMLdata.XMLbase

name.moore.kevin.ze.XMLdata.shipyard

public class shipyard
extends XMLbase

Shipyards are in orbit around planets and build ships and hulls.

Processes the <shipyard>...</shipyard> XML element.

Author:

Kevin Moore <dev@kevin.moore.name>

Field Summary

Fields

Modifier and Type	Field	Description
private static org.slf4j.Logger	LOGGER
private reference	orbiting	Required element in XML <orbiting key="Sol"></orbiting>.
private reference	spec	Required element in XML <spec>SY01</spec>.

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

key

Constructor Summary

Constructors

Constructor	Description
shipyard()

Method Summary

Modifier and Type	Method	Description
Class	getEntityClass()	Derived classes have to override this and say what class eg engine.class they are.
reference	getOrbiting()	The reference will have its default distance of 1.
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

spec

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

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

String reference to the read-only properties of this shipyard.

See Also:

shipyardSpec

orbiting

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

Required element in XML <orbiting key="Sol"></orbiting>.

This is a String reference to another entity to be in orbit around, invariably a planet. It will need to be resolved to a real entity via the procesorFactory

See Also:

name.moore.kevin.ze.entity.entityFactory#makeEntity(name.moore.kevin.ze.XMLdata.XMLbase)

Constructor Details

shipyard

public shipyard()

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:

getOrbiting

public reference getOrbiting()

The reference will have its default distance of 1.

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: