org.apache.tools.ant.types
public class Commandline extends Object implements Cloneable
<someelement>
The element
<acommandline executable="/executable/to/run">
<argument value="argument 1" />
<argument line="argument_1 argument_2 argument_3" />
<argument value="argument 4" />
</acommandline>
</someelement>
someelement must provide a method
createAcommandline which returns an instance of this class.
| Nested Class Summary | |
|---|---|
| static class | Commandline.Argument
Used for nested xml command line definitions. |
| class | Commandline.Marker
Class to keep track of the position of an Argument.
|
| Field Summary | |
|---|---|
| protected static String | DISCLAIMER |
| Constructor Summary | |
|---|---|
| Commandline(String toProcess)
create a command line from a string | |
| Commandline()
Create an empty command line | |
| Method Summary | |
|---|---|
| void | addArguments(String[] line)
append the arguments to the existing command |
| void | addArgumentsToList(ListIterator list)
append all the arguments to the tail of a supplied list |
| void | addCommandToList(ListIterator list)
add the entire command, including (optional) executable to a list |
| void | clear()
Clear out the whole command line. |
| void | clearArgs()
Clear out the arguments but leave the executable in place for
another operation. |
| Object | clone()
Generate a deep clone of the contained object. |
| Commandline.Argument | createArgument()
Creates an argument object.
|
| Commandline.Argument | createArgument(boolean insertAtStart)
Creates an argument object and adds it to our list of args.
|
| Commandline.Marker | createMarker()
Return a marker.
|
| String | describeArguments()
Returns a String that describes the arguments suitable for
verbose output before a call to
Runtime.exec(String[]) |
| static String | describeArguments(Commandline line)
Returns a String that describes the arguments suitable for
verbose output before a call to
Runtime.exec(String[]) |
| static String | describeArguments(String[] args)
Returns a String that describes the arguments suitable for
verbose output before a call to
Runtime.exec(String[]) |
| protected static String | describeArguments(String[] args, int offset)
Returns a String that describes the arguments suitable for
verbose output before a call to
Runtime.exec(String[]) |
| String | describeCommand()
Returns a String that describes the command and arguments
suitable for verbose output before a call to
Runtime.exec(String[]) |
| static String | describeCommand(Commandline line)
Returns a String that describes the command and arguments
suitable for verbose output before a call to
Runtime.exec(String[]) |
| static String | describeCommand(String[] args)
Returns a String that describes the command and arguments
suitable for verbose output before a call to
Runtime.exec(String[]) |
| String[] | getArguments()
Returns all arguments defined by addLine,
addValue or the argument object. |
| String[] | getCommandline()
Returns the executable and all defined arguments. |
| String | getExecutable()
get the executable |
| static String | quoteArgument(String argument)
Put quotes around the given String if necessary.
|
| void | setExecutable(String executable)
Sets the executable to run. |
| int | size()
size operator. |
| String | toString()
stringify operator returns the command line as a string |
| static String | toString(String[] line)
Quotes the parts of the given array in way that makes them
usable as command line arguments. |
| static String[] | translateCommandline(String toProcess)
crack a command line |
Parameters: toProcess the line: the first element becomes the executable, the rest the arguments
Parameters: line an array of arguments to append
Parameters: list
Since: Ant 1.6
Parameters: list
Since: Ant 1.6
Returns: a clone of the contained object
Each commandline object has at most one instance of the
argument class. This method calls
this.createArgument(false).
Returns: the argument object.
See Also: Commandline
Each commandline object has at most one instance of the argument class.
Parameters: insertAtStart if true, the argument is inserted at the beginning of the list of args, otherwise it is appended.
This marker can be used to locate a position on the commandline - to insert something for example - when all parameters have been set.
Runtime.exec(String[])
Since: Ant 1.5
Runtime.exec(String[])
Since: Ant 1.5
Runtime.exec(String[])
Since: Ant 1.5
Runtime.exec(String[])
Parameters: offset ignore entries before this index
Since: Ant 1.5
Runtime.exec(String[])
Since: Ant 1.5
Runtime.exec(String[])
Since: Ant 1.5
Runtime.exec(String[]).
This method assumes that the first entry in the array is the
executable to run.
Since: Ant 1.5
addLine,
addValue or the argument object.Returns: the program to run -null if not yet set
If the argument doesn't include spaces or quotes, return it as is. If it contains double quotes, use single quotes - else surround the argument by double quotes.
Throws: BuildException if the argument contains both, single and double quotes.
Returns: number of elements in the command, including the executable
Returns: the command line
Returns: empty string for null or no command, else every argument split by spaces and quoted by quoting rules
Parameters: toProcess the command line to process
Returns: the command line broken into strings. An empty or null toProcess parameter results in a zero sized array