Request
- Tool-specific request typepublic interface JavaTool<Request extends JavaToolRequest>
Describes a java tool, means a executable available in the jdk.
The name of the tool (getJavaToolName()
) reflects the name of the executable that should exists as an
executable in the jdk, like jarsigner, keytool, javadoc, ...
.
An abstract implementation of the JavaTool
named AbstractJavaTool
use the command line API to
execute any user requests of this tool.
Modifier and Type | Method and Description |
---|---|
JavaToolResult |
execute(Request request)
Execute the input request and then returns the result of the execution.
|
String |
getJavaToolName()
Return the name of the java tool.
|
void |
setToolchain(Object toolchain)
Set an optional tool chain to find out the java tool executable location.
|
String getJavaToolName()
Return the name of the java tool. This is exactly the name (without his extension) of the executable to
find in the jdk/bin
directory.
For example: jarsigner, keytool, javadoc, ...
void setToolchain(Object toolchain)
toolchain
- optional tool chain to find out the java tool executable location.
To avoid direct dependency on Maven core, this parameter is an Object that will be
used as Toolchain through reflectionJavaToolResult execute(Request request) throws JavaToolException
Execute the input request and then returns the result of the execution.
If could not create the java tool invocation, a JavaToolException
will be thrown.
If execution fails, then the result will have a none-zero JavaToolResult.getExitCode()
and his
JavaToolResult.getExecutionException()
will be filled with the error, otherwise the exist code will be
zero.
request
- the request to performJavaToolException
- if could not create the java tool invocationCopyright © 2002–2021 The Apache Software Foundation. All rights reserved.