Package edu.isi.pegasus.planner.invocation

Class JobStatusFailure

  • All Implemented Interfaces:
    HasText, java.io.Serializable
    public class JobStatusFailure
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:
    Job, JobStatus, Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int m_errno
      This is the errno value with the reason that the invocation of the application failed.
      private java.lang.String m_value
      This is the data contained between the tags.

    • Constructor Summary

      Constructors 
      Constructor Description
      JobStatusFailure()
      Default c'tor: Construct a hollow shell and allow further information to be added later.
      JobStatusFailure​(int errno)
      Constructs an error number without reason text.
      JobStatusFailure​(int errno, 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.
      int getError()
      Accessor
      java.lang.String getValue()
      Accessor
      void setError​(int errno)
      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_errno

        private int m_errno
        This is the errno value with the reason that the invocation of the application failed.

      • m_value

        private java.lang.String m_value
        This is the data contained between the tags. A null value is not valid.

    • Constructor Detail

      • JobStatusFailure

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

      • JobStatusFailure

        public JobStatusFailure​(int errno)
        Constructs an error number without reason text.
        Parameters:
        errno - is the error number

      • JobStatusFailure

        public JobStatusFailure​(int errno,
                        java.lang.String value)
        Constructs a piece of data.
        Parameters:
        errno - is the error number .
        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.

      • getError

        public int getError()
        Accessor
        See Also:
        setError(int)

      • setError

        public void setError​(int errno)
        Accessor.
        Parameters:
        errno -
        See Also:
        getError()

      • 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