edu.isi.pegasus.planner.invocation
Class JobStatusSuspend

java.lang.Object
  org.griphyn.vdl.Chimera
      edu.isi.pegasus.planner.invocation.Invocation
          edu.isi.pegasus.planner.invocation.JobStatus
              edu.isi.pegasus.planner.invocation.JobStatusSuspend

All Implemented Interfaces:

HasText, Serializable

public class JobStatusSuspend
extends JobStatus
implements HasText

This class is transient for XML parsing. The data value will be incorporated into the job status classes.

Version:

$Revision: 2587 $

Author:

Jens-S. Vöckler, Yong Zhao

See Also:

StatCall, Serialized Form

Field Summary

private short	m_signo This is the signal number that led to the suspension.
private String	m_value This is the data contained between the tags.

Constructor Summary

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

JobStatusSuspend(short signo)
Constructs an error number without reason text.

JobStatusSuspend(short signo, String value)
Constructs a piece of data.

Method Summary

void	appendValue(String fragment) Appends a piece of text to the existing text.
short	getSignalNumber() Accessor
String	getValue() Accessor
void	setSignalNumber(short signo) Accessor.
void	setValue(String value) Accessor.
void	toString(Writer stream) Converts the active state into something meant for human consumption.
String	toXML(String indent) Dumps the state of the current element as XML output.
void	toXML(Writer stream, String indent, String namespace) Dump 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_value

private String m_value

This is the data contained between the tags. A null value is not valid.

m_signo

private short m_signo

This is the signal number that led to the suspension.

Constructor Detail

JobStatusSuspend

public JobStatusSuspend()

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

JobStatusSuspend

public JobStatusSuspend(short signo)

Constructs an error number without reason text.

Parameters:

signo - is the signal number for the suspension.

JobStatusSuspend

public JobStatusSuspend(short signo,
                        String value)

Constructs a piece of data.

Parameters:

signo - is the signal number for the suspension.

value - is the textual error reason.

Method Detail

appendValue

public void appendValue(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.

getSignalNumber

public short getSignalNumber()

Accessor

See Also:

setSignalNumber(short)

setSignalNumber

public void setSignalNumber(short signo)

Accessor.

Parameters:

signo -

See Also:

getSignalNumber()

getValue

public String getValue()

Accessor

Specified by:

getValue in interface HasText

See Also:

setValue(String)

setValue

public void setValue(String value)

Accessor.

Specified by:

setValue in interface HasText

Parameters:

value - is the new value to set.

See Also:

getValue()

toString

public void toString(Writer stream)
              throws 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:

IOException - if something fishy happens to the stream.

toXML

public String toXML(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(Writer stream,
                  String indent,
                  String namespace)
           throws 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:

IOException - if something fishy happens to the stream.

See Also:

BufferedWriter