Package org.geotoolkit.console

Defines main methods to be invoked from the java command in a shell.

See:
Description

Class Summary

CommandLine	Base class for command line tools.
InteractiveConsole	Base class for applications executing instructions from the console.
ReferencingCommands	Describe the given referencing object.
ReferencingConsole	A console for executing CRS operations from the command line.

Annotation Types Summary

Action	Annotates a method to be invoked when the first argument which is not an option matches the name.
Option	Annotates a field to be assigned from values given on the command line.

Package org.geotoolkit.console Description

Defines main methods to be invoked from the java command in a shell. By default data are read and results are sent to the console. If there is no console attached to the currently running JVM, then data are read from the standard input and results are sent to the standard output streams.

The commands pattern is as below:

java -jar <geotk-module.jar> <options> <action> <parameters...>

where <options> is a list of zero, one or more space-separated options of the form --option=value (or --option alone for options that are boolean flags), <action> is a single word and <parameters...> are values that depend on the action being executed. All commands shall understand at least the help action, which take no parameter.

For implementors
Implementors create a subclass of CommandLine with the following elements:

• Fields annotated by Option. They are the options to be assigned before the action is executed. The fields can be of any type convertible by ConverterRegistry from a String to the field type. This include (but is not limited to) boolean, int, double, String, File and URL.

• Methods annotated by Action. At most one of those will be invoked after the fields have been assigned as a result of the action given by the user on the command line.

• Properties files in the same package and having the same name than the subclass containing the above-cited annotated elements. The properties files may be suffixed by country and language codes as specified by ResourceBundle. They must contain key-value pairs for each of the following keys:

  • Option names, or the field names when no option name is explicitly given.
  • Action names, or the method names when no action name is explicitly given.
  • Description (note the upper-case D) for an overview of what the command does.

  Values must be localized descriptions to be printed when the help action is executed. See here for an example of such properties file.

Since:

2.5

Version:

3.00

Author:

Martin Desruisseaux (IRD)

Module:

utility/geotk-utility (download)