Package name.moore.kevin.ze.XMLdata

Class hull

java.lang.Object

name.moore.kevin.ze.XMLdata.XMLbase

name.moore.kevin.ze.XMLdata.hull

public class hull
extends XMLbase

Hulls provide a container to allow other components to be collected together into a ship.

Author:

Kevin Moore <dev@kevin.moore.name>

Field Summary

Fields

Modifier and Type	Field	Description
private javax.measure.Measure<Double,javax.measure.quantity.Dimensionless>	health	Optional XML element to specify the health of this component, defaults to 100 (percent).
private static org.slf4j.Logger	LOGGER
private reference	spec	Required element in XML <spec key="H01"></spec>.

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

key

Constructor Summary

Constructors

Constructor	Description
hull()

Method Summary

Modifier and Type	Method	Description
Class	getEntityClass()	Derived classes have to override this and say what class eg engine.class they are.
javax.measure.Measure<Double,javax.measure.quantity.Dimensionless>	getHealth()
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 key="H01"></spec>.

The technical specification of the hull.

See Also:

hullSpec, spec

health

@XStreamConverter(SingleValuePercentConverter.class)
private javax.measure.Measure<Double,javax.measure.quantity.Dimensionless> health

Optional XML element to specify the health of this component, defaults to 100 (percent).

<health>45.1</health> Any values supplied over 100.00 will be chopped to 100.00

Constructor Details

hull

public hull()

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:

getHealth

public javax.measure.Measure<Double,javax.measure.quantity.Dimensionless> getHealth()

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: