Top Description Inners Fields Constructors Methods

io.vertx.core.impl.launcher

public Class VertxCommandLauncher

Class Inheritance

extends UsageMessageFormatter

java.lang.Object
io.vertx.core.cli.UsageMessageFormatter
io.vertx.core.impl.launcher.VertxCommandLauncher

Known Direct Subclasses

io.vertx.core.Launcher

Imports

io.vertx.core.cli.*, io.vertx.core.cli.annotations.CLIConfigurator, io.vertx.core.impl.launcher.commands.RunCommand, io.vertx.core.spi.launcher.*, java.io.IOException, .InputStream, .PrintStream, java.net.URL, java.util.*, java.util.function.Supplier, java.util.jar.Attributes, .Manifest, java.util.stream.Collectors

The entry point of the Vert.x Command Line interface.

Author: Clement Escoffier

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VertxCommandLauncher.CommandRegistration Handles a command registration.

Field Summary

Modifier and Type	Field and Description
protected final Map<String, VertxCommandLauncher.CommandRegistration>	commandByName the list of commands.
protected final List<CommandFactoryLookup>	lookups the list of lookups.
protected Object	main the `Main-Class` object.
protected static List<String>	PROCESS_ARGS

Inherited from io.vertx.core.cli.UsageMessageFormatter:: DEFAULT_ARG_NAME DEFAULT_DESC_PAD DEFAULT_LEFT_PAD DEFAULT_LONG_OPT_PREFIX DEFAULT_LONG_OPT_SEPARATOR DEFAULT_OPT_PREFIX DEFAULT_USAGE_PREFIX DEFAULT_WIDTH optionComparator

Constructor Summary

Access	Constructor and Description
public	VertxCommandLauncher() Creates a new `VertxCommandLauncher` using the default `ServiceCommandFactoryLoader`.
public	VertxCommandLauncher(Collection<CommandFactoryLookup> the list of lookup lookups) Creates a new `VertxCommandLauncher` using the given list of `CommandFactoryLookup`.

Method Summary

Modifier and Type	Method and Description
public void	dispatch(String[] the command line arguments. args) Dispatches to the right command.
public void	dispatch(Object the main instance on which hooks and callbacks are going to be called. If not set, the current object is used. main, String[] the command line arguments. args) Dispatches to the right command.
public void	execute(String the command name command, String... the arguments cla) Executes the given command.
protected String	getCommandFromManifest()
protected String	getCommandLinePrefix()
public Collection<String>	Returns: the list of command. getCommandNames()
protected String	Returns: the default command if specified in the `MANIFEST`, "run" if not found. getDefaultCommand()
public Command	Returns: the `Command` instance, `null` if not found getExistingCommandInstance(String the command name name) Gets an existing instance of command.
private String	getFromManifest(String key)
protected String	Returns: the main verticle, `null` if not found. getMainVerticle()
protected Command	Returns: the new instance, `null` if the command cannot be found. getNewCommandInstance(String the command name name, CommandLine the command line commandLine) Creates a new `Command` instance.
public PrintStream	Returns: the printer used to write the messages. Defaults to `System#out`. getPrintStream()
public static List<String>	Returns: the process argument. Verticles can use this method to retrieve the arguments. getProcessArguments()
protected static boolean	isAskingForHelp(String command)
protected static boolean	isAskingForVersion(String command)
protected void	load() Loads the command.
protected void	printCommandNotFound(String command)
protected void	printCommandUsage(CLI cli)
protected void	printGenericExecutionError(CLI cli, CLIException e)
protected void	printGlobalUsage()
protected void	printSpecificException(CLI cli, Exception e)
public VertxCommandLauncher	register(CommandFactory<C extends Command> factory)
public VertxCommandLauncher	register(Class<? extends Command> clazz) Deprecated
public VertxCommandLauncher	register(Class<? extends Command> clazz, Supplier<? extends Command> supplier)
public static void	resetProcessArguments() For testing purpose only - reset the process arguments
public VertxCommandLauncher	unregister(String name)

Field Detail

commandByName	back to summary
protected final Map<String, VertxCommandLauncher.CommandRegistration> commandByName the list of commands. Sub-classes can decide to remove commands by removing entries from this map.

lookups	back to summary
protected final List<CommandFactoryLookup> lookups the list of lookups.

main	back to summary
protected Object main the `Main-Class` object.

PROCESS_ARGS	back to summary
protected static List<String> PROCESS_ARGS

Constructor Detail

VertxCommandLauncher	back to summary
public VertxCommandLauncher() Creates a new `VertxCommandLauncher` using the default `ServiceCommandFactoryLoader`. It uses the classloader having loaded `ServiceCommandFactoryLoader`.

VertxCommandLauncher back to summary

VertxCommandLauncher	back to summary
public VertxCommandLauncher(Collection<CommandFactoryLookup> lookups) Creates a new `VertxCommandLauncher` using the given list of `CommandFactoryLookup`. Parameters lookups:Collection<CommandFactoryLookup> the list of lookup

public VertxCommandLauncher(Collection<CommandFactoryLookup> lookups)

Creates a new VertxCommandLauncher using the given list of CommandFactoryLookup.

Parameters

lookups:Collection<CommandFactoryLookup>: the list of lookup

Method Detail

dispatch back to summary

dispatch	back to summary
public void dispatch(String[] args) Dispatches to the right command. This method is generally called from the `main` method. Parameters args:String[] the command line arguments.

public void dispatch(String[] args)

Dispatches to the right command. This method is generally called from the main method.

Parameters

args:String[]: the command line arguments.

dispatch back to summary

dispatch	back to summary
public void dispatch(Object main, String[] args) Dispatches to the right command. This method is generally called from the `main` method. Parameters main:Object the main instance on which hooks and callbacks are going to be called. If not set, the current object is used. args:String[] the command line arguments.

public void dispatch(Object main, String[] args)

Dispatches to the right command. This method is generally called from the main method.

Parameters

main:Object: the main instance on which hooks and callbacks are going to be called. If not set, the current object is used.
args:String[]: the command line arguments.

execute	back to summary
public void execute(String command, String... cla) Executes the given command. Parameters command:String the command name cla:String[] the arguments

execute

back to summary

public void execute(String command, String... cla)

Executes the given command.

Parameters

command:String: the command name
cla:String[]: the arguments

getCommandFromManifest	back to summary
protected String getCommandFromManifest()

getCommandLinePrefix	back to summary
protected String getCommandLinePrefix()

getCommandNames	back to summary
public Collection<String> getCommandNames() Returns:Collection<String> the list of command.

getDefaultCommand	back to summary
protected String getDefaultCommand() Returns:String the default command if specified in the `MANIFEST`, "run" if not found.

getExistingCommandInstance back to summary

getExistingCommandInstance	back to summary
public Command getExistingCommandInstance(String name) Gets an existing instance of command. Parameters name:String the command name Returns:Command the `Command` instance, `null` if not found

public Command getExistingCommandInstance(String name)

Gets an existing instance of command.

Parameters

name:String: the command name

Returns:Command

the Command instance, null if not found

getFromManifest	back to summary
private String getFromManifest(String key)

getMainVerticle	back to summary
protected String getMainVerticle() Returns:String the main verticle, `null` if not found.

getNewCommandInstance back to summary

getNewCommandInstance	back to summary
protected Command getNewCommandInstance(String name, CommandLine commandLine) Creates a new `Command` instance. Sub-classes can change how `Command` instance are created. Parameters name:String the command name commandLine:CommandLine the command line Returns:Command the new instance, `null` if the command cannot be found.

protected Command getNewCommandInstance(String name, CommandLine commandLine)

Creates a new Command instance. Sub-classes can change how Command instance are created.

Parameters

name:String: the command name
commandLine:CommandLine: the command line

Returns:Command

the new instance, null if the command cannot be found.

getPrintStream	back to summary
public PrintStream getPrintStream() Returns:PrintStream the printer used to write the messages. Defaults to `System#out`.

getProcessArguments	back to summary
public static List<String> getProcessArguments() Returns:List<String> the process argument. Verticles can use this method to retrieve the arguments.

isAskingForHelp	back to summary
protected static boolean isAskingForHelp(String command)

isAskingForVersion	back to summary
protected static boolean isAskingForVersion(String command)

load	back to summary
protected void load() Loads the command. This method is `protected` to let sub-classes change the set of command or how they are loaded.

printCommandNotFound	back to summary
protected void printCommandNotFound(String command)

printCommandUsage	back to summary
protected void printCommandUsage(CLI cli)

printGenericExecutionError	back to summary
protected void printGenericExecutionError(CLI cli, CLIException e)

printGlobalUsage	back to summary
protected void printGlobalUsage()

printSpecificException	back to summary
protected void printSpecificException(CLI cli, Exception e)

register	back to summary
public VertxCommandLauncher register(CommandFactory<C extends Command> factory)

register	back to summary
public VertxCommandLauncher register(Class<? extends Command> clazz) Deprecated Annotations @Deprecated @SuppressWarnings:unchecked

register	back to summary
public VertxCommandLauncher register(Class<? extends Command> clazz, Supplier<? extends Command> supplier) Annotations @SuppressWarnings:unchecked

resetProcessArguments	back to summary
public static void resetProcessArguments() For testing purpose only - reset the process arguments

unregister	back to summary
public VertxCommandLauncher unregister(String name)

io.vertx.core.impl.launcher back to summary

public Class VertxCommandLauncher.CommandRegistration

Class Inheritance

extends Object

java.lang.Object
io.vertx.core.impl.launcher.VertxCommandLauncher.CommandRegistration

Handles a command registration.

Field Summary

Modifier and Type	Field and Description
public final CLI	cli
private List<Command>	commands
public final CommandFactory<C extends Command>	factory

Constructor Summary

Access	Constructor and Description
public	CommandRegistration(CommandFactory<C extends Command> factory)
public	CommandRegistration(CommandFactory<C extends Command> factory, CLI cli)

Method Summary

Modifier and Type	Method and Description
public void	addCommand(Command command)
public Command	getCommand()
public List<Command>	getCommands()

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

Field Detail

cli	back to summary
public final CLI cli

commands	back to summary
private List<Command> commands

factory	back to summary
public final CommandFactory<C extends Command> factory

Constructor Detail

CommandRegistration	back to summary
public CommandRegistration(CommandFactory<C extends Command> factory)

CommandRegistration	back to summary
public CommandRegistration(CommandFactory<C extends Command> factory, CLI cli)

Method Detail

addCommand	back to summary
public void addCommand(Command command)

getCommand	back to summary
public Command getCommand()

getCommands	back to summary
public List<Command> getCommands()