|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.types.Commandline
Commandline objects help handling command lines specifying processes to execute. The class can be used to define a command line as nested elements or as a helper to define a command line by an application.
<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 java.lang.String |
DISCLAIMER
|
Constructor Summary | |
Commandline()
|
|
Commandline(java.lang.String to_process)
|
Method Summary | |
void |
addArguments(java.lang.String[] line)
|
void |
clear()
Clear out the whole command line. |
void |
clearArgs()
Clear out the arguments but leave the executable in place for another operation. |
java.lang.Object |
clone()
|
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. |
java.lang.String |
describeArguments()
Returns a String that describes the arguments suitable for verbose output before a call to Runtime.exec(String[]) |
static java.lang.String |
describeArguments(Commandline line)
Returns a String that describes the arguments suitable for verbose output before a call to Runtime.exec(String[]) |
static java.lang.String |
describeArguments(java.lang.String[] args)
Returns a String that describes the arguments suitable for verbose output before a call to Runtime.exec(String[]) |
protected static java.lang.String |
describeArguments(java.lang.String[] args,
int offset)
Returns a String that describes the arguments suitable for verbose output before a call to Runtime.exec(String[]) |
java.lang.String |
describeCommand()
Returns a String that describes the command and arguments suitable for verbose output before a call to Runtime.exec(String[]) |
static java.lang.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 java.lang.String |
describeCommand(java.lang.String[] args)
Returns a String that describes the command and arguments suitable for verbose output before a call to Runtime.exec(String[]) |
java.lang.String[] |
getArguments()
Returns all arguments defined by addLine ,
addValue or the argument object. |
java.lang.String[] |
getCommandline()
Returns the executable and all defined arguments. |
java.lang.String |
getExecutable()
|
static java.lang.String |
quoteArgument(java.lang.String argument)
Put quotes around the given String if necessary. |
void |
setExecutable(java.lang.String executable)
Sets the executable to run. |
int |
size()
|
java.lang.String |
toString()
|
static java.lang.String |
toString(java.lang.String[] line)
Quotes the parts of the given array in way that makes them usable as command line arguments. |
static java.lang.String[] |
translateCommandline(java.lang.String to_process)
|
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected static final java.lang.String DISCLAIMER
Constructor Detail |
public Commandline(java.lang.String to_process)
public Commandline()
Method Detail |
public Commandline.Argument createArgument()
Each commandline object has at most one instance of the
argument class. This method calls
this.createArgument(false)
.
createArgument(boolean)
public Commandline.Argument createArgument(boolean insertAtStart)
Each commandline object has at most one instance of the argument class.
insertAtStart
- if true, the argument is inserted at the
beginning of the list of args, otherwise it is appended.public void setExecutable(java.lang.String executable)
public java.lang.String getExecutable()
public void addArguments(java.lang.String[] line)
public java.lang.String[] getCommandline()
public java.lang.String[] getArguments()
addLine
,
addValue
or the argument object.
public java.lang.String toString()
toString
in class java.lang.Object
public static java.lang.String quoteArgument(java.lang.String argument)
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.
BuildException
- if the argument contains both, single
and double quotes.public static java.lang.String toString(java.lang.String[] line)
public static java.lang.String[] translateCommandline(java.lang.String to_process)
public int size()
public java.lang.Object clone()
clone
in class java.lang.Object
public void clear()
public void clearArgs()
public Commandline.Marker createMarker()
This marker can be used to locate a position on the commandline - to insert something for example - when all parameters have been set.
public java.lang.String describeCommand()
Runtime.exec(String[])
- Since:
- Ant 1.5
public java.lang.String describeArguments()
Runtime.exec(String[])
- Since:
- Ant 1.5
public static java.lang.String describeCommand(Commandline line)
Runtime.exec(String[])
- Since:
- Ant 1.5
public static java.lang.String describeArguments(Commandline line)
Runtime.exec(String[])
- Since:
- Ant 1.5
public static java.lang.String describeCommand(java.lang.String[] args)
Runtime.exec(String[]).
This method assumes that the first entry in the array is the
executable to run.
- Since:
- Ant 1.5
public static java.lang.String describeArguments(java.lang.String[] args)
Runtime.exec(String[])
- Since:
- Ant 1.5
protected static java.lang.String describeArguments(java.lang.String[] args, int offset)
Runtime.exec(String[])
- Parameters:
offset
- ignore entries before this index- Since:
- Ant 1.5
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |