Vert.x 4.5.13 · io.vertx.core.spi.launcher.DefaultCommand

Default implementation of Command using annotation to define itself. It is highly recommended to extend this class when implementing a command.

It defines two hidden Options to create system properties (-Dkey=value) and a way to configure the current working directory.

Field Summary

Modifier and Type	Field and Description
private File	cwd
protected ExecutionContext	executionContext The execution context of the command.
protected PrintStream	out The `PrintStream` that the command can use to write on the console.
protected List<String>	systemProperties

Constructor Summary

Access	Constructor and Description
public	DefaultCommand()

Method Summary

Modifier and Type	Method and Description
protected void	applySystemProperties() Sets the system properties specified by the user command line.
public File	Returns: the configure current working directory. If not set use the "regular" Java current working directory. getCwd()
public PrintStream	Returns: the print stream on which message should be written. out()
public void	setCwd(File the directory cwd) Sets the current working directory.
public void	setSystemProps(List<String> the properties props) Gets system properties passed in the user command line.
public void	setUp(ExecutionContext the context ec) Implements io.vertx.core.spi.launcher.Command.setUp. Set up the command execution environment.
public void	tearDown() Implements io.vertx.core.spi.launcher.Command.tearDown. The command has been executed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cwd	back to summary
private File cwd

executionContext	back to summary
protected ExecutionContext executionContext The execution context of the command.

out	back to summary
protected PrintStream out The `PrintStream` that the command can use to write on the console.

systemProperties	back to summary
protected List<String> systemProperties

Constructor Detail

DefaultCommand	back to summary
public DefaultCommand()

Method Detail

applySystemProperties	back to summary
protected void applySystemProperties() Sets the system properties specified by the user command line.

getCwd	back to summary
public File getCwd() Returns:File the configure current working directory. If not set use the "regular" Java current working directory.

out	back to summary
public PrintStream out() Returns:PrintStream the print stream on which message should be written.

setCwd back to summary

setCwd	back to summary
public void setCwd(File cwd) Sets the current working directory. This method is called when the user configure the "cwd" option as follows: `--cwd=the-directory`. Parameters cwd:File the directory Annotations @SuppressWarnings:unused @Option longName:cwd argName:dir @Description:Specifies the current working directory for this command, default set to the Java current directory @Hidden

public void setCwd(File cwd)

Sets the current working directory. This method is called when the user configure the "cwd" option as follows: --cwd=the-directory.

Parameters

cwd:File: the directory

Annotations

@SuppressWarnings:unused
@Option
longName:cwd
argName:dir
@Description:Specifies the current working directory for this command, default set to the Java current directory
@Hidden

setSystemProps back to summary

setSystemProps	back to summary
public void setSystemProps(List<String> props) Gets system properties passed in the user command line. The user can configure system properties using `-Dkey=value`. Parameters props:List<String> the properties Annotations @SuppressWarnings:unused @Option longName:systemProperty shortName:D argName:key>=@Description:Set a system property @Hidden

public void setSystemProps(List<String> props)

Gets system properties passed in the user command line. The user can configure system properties using -Dkey=value.

Parameters

props:List<String>: the properties

Annotations

@SuppressWarnings:unused
@Option
longName:systemProperty
shortName:D
argName:key>=@Description:Set a system property
@Hidden

setUp	back to summary
public void setUp(ExecutionContext ec) throws CLIException Implements io.vertx.core.spi.launcher.Command.setUp. Doc from io.vertx.core.spi.launcher.Command.setUp. Set up the command execution environment. The command line model has been retrieved and is frozen. Values has been set / injected. You can use this callback to validate the inputs. Parameters ec:ExecutionContext the context Annotations @Override Exceptions CLIException: if the validation failed

setUp

back to summary

public void setUp(ExecutionContext ec) throws CLIException

Implements io.vertx.core.spi.launcher.Command.setUp.

Doc from io.vertx.core.spi.launcher.Command.setUp.

Set up the command execution environment. The command line model has been retrieved and is frozen. Values has been set / injected. You can use this callback to validate the inputs.

Parameters

ec:ExecutionContext: the context

Annotations

@Override

Exceptions

CLIException:: if the validation failed

tearDown	back to summary
public void tearDown() throws CLIException Implements io.vertx.core.spi.launcher.Command.tearDown. Doc from io.vertx.core.spi.launcher.Command.tearDown. The command has been executed. Use this method to cleanup the environment. Annotations @Override Exceptions CLIException: if anything went wrong

tearDown

back to summary

public void tearDown() throws CLIException

Implements io.vertx.core.spi.launcher.Command.tearDown.

Doc from io.vertx.core.spi.launcher.Command.tearDown.

The command has been executed. Use this method to cleanup the environment.

Annotations