org.eclipse.ptp.core.util

Class ArgumentParser

java.lang.Object

org.eclipse.ptp.core.util.ArgumentParser

public class ArgumentParser
extends java.lang.Object

Utilitiy class for managing command line arguments.

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
ArgumentParser(java.util.List<java.lang.String> tokenList) Create a command line representation from an array of strings.
ArgumentParser(java.lang.String commandline) Create a command line representation from the string with a shell command line.
ArgumentParser(java.lang.String[] tokenArray) Create a command line representation from an array of strings.
ArgumentParser(java.lang.String command, java.util.List<java.lang.String> parameterList) Create a command line representation from the command and an list of parameters.
ArgumentParser(java.lang.String command, java.lang.String[] parameterArray) Create a command line representation from the command and an array of parameters.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCommand() Returns the command of the command line, assuming that the first entry is always the command.
java.lang.String	getCommandLine(boolean fullEscape) Convert all tokens in a full command line that can be executed in a shell.
java.lang.String	getEscapedCommand(boolean fullEscalpe) Returns the command of the command line, assuming that the first entry is always the command.
java.lang.String[]	getParameterArray() Returns a list of all arguments, assuming that the first entry is the command name.
java.util.List<java.lang.String>	getParameterList() Returns a list of all arguments, assuming that the first entry is the command name.
int	getSize() Returns the total number of entries.
java.lang.String[]	getTokenArray() Returns a List of all entries of the command line.
java.util.List<java.lang.String>	getTokenList() Returns a List of all entries of the command line.
java.lang.String	toString() Returns a representation of the command line for debug purposes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ArgumentParser

public ArgumentParser(java.lang.String commandline)

Create a command line representation from the string with a shell command line. The command line is parsed and split on spaces. Quoted or escaped spaces are preserved..

Since:

2.0

ArgumentParser

public ArgumentParser(java.lang.String[] tokenArray)

Create a command line representation from an array of strings. The first element of the array is assumed to be the command, the remaining, the arguments. The elements are not parsed not (un)escaped., but taked as the are.

Since:

2.0

ArgumentParser

public ArgumentParser(java.util.List<java.lang.String> tokenList)

Create a command line representation from an array of strings. The first element of the list is assumed to be the command, the remaining, the arguments. The elements are not parsed not (un)escaped., but taked as the are.

Since:

2.0

ArgumentParser

public ArgumentParser(java.lang.String command,
              java.lang.String[] parameterArray)

Create a command line representation from the command and an array of parameters. The elements are not parsed not (un)escaped., but taked as the are.

Since:

2.0

ArgumentParser

public ArgumentParser(java.lang.String command,
              java.util.List<java.lang.String> parameterList)

Create a command line representation from the command and an list of parameters. The elements are not parsed not (un)escaped., but taked as the are.

Since:

2.0

Method Detail

getCommandLine

public java.lang.String getCommandLine(boolean fullEscape)

Convert all tokens in a full command line that can be executed in a shell.

Parameters:

fullEscape - If every special character shall be escaped. If false, only white spaces are escaped and the shell will interpret the special chars. If true, then all special chars are quoted.

Since:

2.0

getTokenArray

public java.lang.String[] getTokenArray()

Returns a List of all entries of the command line.

Returns:

The Array

Since:

2.0

getTokenList

public java.util.List<java.lang.String> getTokenList()

Returns a List of all entries of the command line.

Returns:

The List

Since:

2.0

getCommand

public java.lang.String getCommand()

Returns the command of the command line, assuming that the first entry is always the command.

Returns:

The command or null if the command lines has no command nor arguments.

Since:

2.0

getEscapedCommand

public java.lang.String getEscapedCommand(boolean fullEscalpe)

Returns the command of the command line, assuming that the first entry is always the command.

Parameters:

fullEscape - If every special character shall be escaped. If false, only white spaces are escaped and the shell will interpret the special chars. If true, then all special chars are quoted.

Returns:

The command or null if the command lines has no command nor arguments.

Since:

2.0

getParameterArray

public java.lang.String[] getParameterArray()

Returns a list of all arguments, assuming that the first entry is the command name.

Returns:

The Array or null if the command lines has no command nor arguments.

Since:

2.0

getParameterList

public java.util.List<java.lang.String> getParameterList()

Returns a list of all arguments, assuming that the first entry is the command name.

Returns:

The List or null if the command lines has no command nor arguments.

Since:

2.0

getSize

public int getSize()

Returns the total number of entries.

Returns:

Since:

2.0

toString

public java.lang.String toString()

Returns a representation of the command line for debug purposes.

Overrides:

toString in class java.lang.Object