Class JobStatusSignal

  • All Implemented Interfaces:
    HasText, java.io.Serializable

    public class JobStatusSignal
    extends JobStatus
    implements HasText
    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 boolean m_core
      This flag signals, if a core file was generated.
      private short m_signo
      This is the signal number that led to the process termination.
      private java.lang.String m_value
      This is the signal name or message contained between the tags.
    • Constructor Summary

      Constructors 
      Constructor Description
      JobStatusSignal()
      Default c'tor: Construct a hollow shell and allow further information to be added later.
      JobStatusSignal​(short signo)
      Constructs an error number without reason text.
      JobStatusSignal​(short signo, boolean core)
      Constructs a piece of data.
      JobStatusSignal​(short signo, boolean core, java.lang.String value)
      Constructs a piece of data.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void appendValue​(java.lang.String fragment)
      Appends a piece of text to the existing text.
      boolean getCoreFlag()
      Accessor
      short getSignalNumber()
      Accessor
      java.lang.String getValue()
      Accessor
      void setCoreFlag​(boolean core)
      Accessor.
      void setSignalNumber​(short signo)
      Accessor.
      void setValue​(java.lang.String value)
      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_signo

        private short m_signo
        This is the signal number that led to the process termination.
      • m_core

        private boolean m_core
        This flag signals, if a core file was generated. Not all systems support core files.
      • m_value

        private java.lang.String m_value
        This is the signal name or message contained between the tags.
    • Constructor Detail

      • JobStatusSignal

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

        public JobStatusSignal​(short signo)
        Constructs an error number without reason text.
        Parameters:
        signo - is the error number
      • JobStatusSignal

        public JobStatusSignal​(short signo,
                               boolean core)
        Constructs a piece of data.
        Parameters:
        signo - is the error number.
        core - is the core flag.
      • JobStatusSignal

        public JobStatusSignal​(short signo,
                               boolean core,
                               java.lang.String value)
        Constructs a piece of data.
        Parameters:
        signo - is the error number.
        core - is the core flag.
        value - is the textual error reason.
    • Method Detail

      • appendValue

        public void appendValue​(java.lang.String fragment)
        Appends a piece of text to the existing text.
        Specified by:
        appendValue in interface HasText
        Parameters:
        fragment - is a piece of text to append to existing text. Appending null is a noop.
      • setSignalNumber

        public void setSignalNumber​(short signo)
        Accessor.
        Parameters:
        signo -
        See Also:
        getSignalNumber()
      • setCoreFlag

        public void setCoreFlag​(boolean core)
        Accessor.
        Parameters:
        core -
        See Also:
        getCoreFlag()
      • setValue

        public void setValue​(java.lang.String value)
        Accessor.
        Specified by:
        setValue in interface HasText
        Parameters:
        value - is the new value to set.
        See Also:
        getValue()
      • 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