org.mdi.bootstrap.launcher

Interface CommandLineListener

All Known Subinterfaces:

MDIPlugin<C>, Plugin, SwingMDIPlugin

All Known Implementing Classes:

AbstractApplication, AbstractJFXMDIPlugin, AbstractMDIApplication, AbstractMDIPlugin, AbstractPlugin, AbstractSwingMDIPlugin

public interface CommandLineListener

The command-line listener. You should implement in your listener the two following methods:

• getCommandLineConfiguration() which points to the URL describing the arguments structure used by the listener
• handleCommandLineArguments(java.util.Map, java.util.Map) which points to the method specifying how to handle the parsed arguments

Since:

1.3.6

Method Summary

Modifier and Type	Method and Description
default java.net.URL	getCommandLineConfiguration() Return the configuration of the CommandLine arguments managed by the Plugin.
default CommandLineHandler	getCommandLineHandler() Return the command-line handler.
default boolean	handleCommandLineArguments(java.io.File dir, java.util.Map<java.lang.String,java.lang.String> arguments) Return true if this listener handles command-line arguments.
default void	handleCommandLineArguments(java.util.Map<java.lang.String,ArgumentGroup> argumentGroups, java.util.Map<java.lang.String,Argument> arguments)
default void	handleCommandLineException(org.xml.sax.SAXParseException exception) Called when a SAX exception appear when parsing the command-line configuration.
default void	setCommandLineHandler(CommandLineHandler handler) Set the command-line handler.

Method Detail

setCommandLineHandler

default void setCommandLineHandler(CommandLineHandler handler)

Set the command-line handler. Do nothing by default.

Parameters:

handler - the handler

getCommandLineHandler

default CommandLineHandler getCommandLineHandler()

Return the command-line handler. Return null by default.

Returns:

the handler

getCommandLineConfiguration

default java.net.URL getCommandLineConfiguration()

Return the configuration of the CommandLine arguments managed by the Plugin. Return null by default.

Returns:

the configuration of the command-line arguments managed by the Plugin

handleCommandLineArguments

default boolean handleCommandLineArguments(java.io.File dir,
                                           java.util.Map<java.lang.String,java.lang.String> arguments)

Return true if this listener handles command-line arguments.

Parameters:

dir - the base directory

arguments - the arguments

Returns:

true if this listener handles command-line arguments

handleCommandLineArguments

default void handleCommandLineArguments(java.util.Map<java.lang.String,ArgumentGroup> argumentGroups,
                                        java.util.Map<java.lang.String,Argument> arguments)

handleCommandLineException

default void handleCommandLineException(org.xml.sax.SAXParseException exception)

Called when a SAX exception appear when parsing the command-line configuration.

Parameters:

exception - the SAX exception