Class JobStatusRegular

  • All Implemented Interfaces:
    java.io.Serializable

    public class JobStatusRegular
    extends JobStatus
    This class is transient for XML parsing. The data value will be incorporated into the job status classes.
    Version:
    $Revision$
    Author:
    Jens-S. Vöckler, Yong Zhao
    See Also:
    StatCall, Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private short m_exitcode
      This is exit code returned by the application.
    • Constructor Summary

      Constructors 
      Constructor Description
      JobStatusRegular()
      Default c'tor: Construct a hollow shell and allow further information to be added later.
      JobStatusRegular​(short exitcode)
      Constructs an exit code.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      short getExitCode()
      Accessor
      void setExitCode​(short exitcode)
      Accessor.
      void toString​(java.io.Writer stream)
      Converts the active state into something meant for human consumption.
      void toXML​(java.io.Writer stream, java.lang.String indent, java.lang.String namespace)
      Dump the state of the current element as XML output.
      java.lang.String toXML​(java.lang.String indent)
      Dumps the state of the current element as XML output.
      • Methods inherited from class org.griphyn.vdl.Chimera

        escape, quote, toString, toXML, toXML, writeAttribute
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • m_exitcode

        private short m_exitcode
        This is exit code returned by the application.
    • Constructor Detail

      • JobStatusRegular

        public JobStatusRegular()
        Default c'tor: Construct a hollow shell and allow further information to be added later.
      • JobStatusRegular

        public JobStatusRegular​(short exitcode)
        Constructs an exit code.
        Parameters:
        exitcode - is the exit code of the application.
    • Method Detail

      • setExitCode

        public void setExitCode​(short exitcode)
        Accessor.
        Parameters:
        exitcode -
        See Also:
        getExitCode()
      • toString

        public void toString​(java.io.Writer stream)
                      throws java.io.IOException
        Converts the active state into something meant for human consumption. The method will be called when recursively traversing the instance tree.
        Specified by:
        toString in class org.griphyn.vdl.Chimera
        Parameters:
        stream - is a stream opened and ready for writing. This can also be a string stream for efficient output.
        Throws:
        java.io.IOException - if something fishy happens to the stream.
      • toXML

        public java.lang.String toXML​(java.lang.String indent)
        Dumps the state of the current element as XML output. This function can return the necessary data more efficiently, thus overwriting the inherited method.
        Parameters:
        indent - is a String of spaces used for pretty printing. The initial amount of spaces should be an empty string. The parameter is used internally for the recursive traversal.
        Returns:
        a String which contains the state of the current class and its siblings using XML. Note that these strings might become large.
      • toXML

        public void toXML​(java.io.Writer stream,
                          java.lang.String indent,
                          java.lang.String namespace)
                   throws java.io.IOException
        Dump the state of the current element as XML output. This function traverses all sibling classes as necessary, and converts the data into pretty-printed XML output. The stream interface should be able to handle large output efficiently.
        Specified by:
        toXML in class org.griphyn.vdl.Chimera
        Parameters:
        stream - is a stream opened and ready for writing. This can also be a string stream for efficient output.
        indent - is a String of spaces used for pretty printing. The initial amount of spaces should be an empty string. The parameter is used internally for the recursive traversal. If a null value is specified, no indentation nor linefeeds will be generated.
        namespace - is the XML schema namespace prefix. If neither empty nor null, each element will be prefixed with this prefix, and the root element will map the XML namespace.
        Throws:
        java.io.IOException - if something fishy happens to the stream.
        See Also:
        BufferedWriter