Package name.moore.kevin.ze.XMLdata

Class reference

java.lang.Object
name.moore.kevin.ze.XMLdata.XMLbase
name.moore.kevin.ze.XMLdata.reference
public class reference extends XMLbase
Process the XML of form <reference key="Sol">3</reference> into an object.

A reference is a String 'pointer' to the Name component of another entity. So the example points to an entity with Name = "Sol". The @XStreamAlias used will decide the XML element name (ie the 'orbiting' bit) The XML value is optional defaults to 1.

Extending XMLbase provides the String attribute key, an unused description field and the ...XMLmessage() methods.

Author:
Kevin Moore <dev@kevin.moore.name>

  • Field Details

    • LOGGER

      private static final org.slf4j.Logger LOGGER

    • value

      private Integer value

  • Constructor Details

    • reference

      public reference​(String key)
      Parameters:
      key -

  • Method Details

    • getIntegerValue

      public Integer getIntegerValue()
      If this wasn't provided in XML, then it will return the default 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: