org.griphyn.vdl.invocation
Class CommandLine

java.lang.Object
  org.griphyn.vdl.Chimera
      org.griphyn.vdl.invocation.Invocation
          org.griphyn.vdl.invocation.CommandLine

All Implemented Interfaces:

Serializable, HasText

public class CommandLine
extends Invocation
implements HasText

This class maintains the application that was run, and the arguments to the commandline that were actually passed on to the application.

Version:

$Revision: 50 $

Author:

Jens-S. V??ckler, Yong Zhao

See Also:

Job, Serialized Form

Field Summary

private String	m_executable This is the executable that was run.
private StringBuffer	m_value This is the data contained between the tags.

Constructor Summary

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

CommandLine(String executable)
Constructs an applications without arguments.

CommandLine(String executable, String value)
Constructs an applications with arguments.

Method Summary

void	appendValue(String fragment) Appends a piece of text to the existing text.
String	getExecutable() Accessor
String	getValue() Accessor
void	setExecutable(String executable) 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_executable

private String m_executable

This is the executable that was run.

m_value

private StringBuffer m_value

This is the data contained between the tags. There may be no data.

Constructor Detail

CommandLine

public CommandLine()

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

CommandLine

public CommandLine(String executable)

Constructs an applications without arguments.

Parameters:

executable - is the name of the application.

CommandLine

public CommandLine(String executable,
                   String value)

Constructs an applications with arguments.

Parameters:

executable - is the name of the application.

value - represents the argument line passed.

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.

getExecutable

public String getExecutable()

Accessor

See Also:

setExecutable(String)

setExecutable

public void setExecutable(String executable)

Accessor.

Parameters:

executable -

See Also:

getExecutable()

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 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 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