|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.geotools.console.CommandLine
public class CommandLine
Base class for command line tools. Subclasses define fields annotated with Option
,
while will be initialized automatically by the constructor. The following options are
automatically recognized by this class:
-encoding | Set the input and output encoding. |
-help | Print the help summary. |
-locale | Set the locale for string, number and date formatting. |
Field Summary | |
---|---|
static int |
ABORT_EXIT_CODE
The code given to System.exit(int) when the program aborted at user request. |
protected java.lang.String[] |
arguments
The remaining arguments after all option values have been assigned to the fields. |
static int |
BAD_CONTENT_EXIT_CODE
The code given to System.exit(int) when the program failed because of bad
content in a file. |
protected java.io.PrintWriter |
err
Error stream to the console. |
static int |
ILLEGAL_ARGUMENT_EXIT_CODE
The code given to System.exit(int) when the program failed because of an illegal
user argument. |
static int |
IO_EXCEPTION_EXIT_CODE
The code given to System.exit(int) when the program failed because of an
IOException . |
protected java.util.Locale |
locale
The locale inferred from the "-locale" option. |
protected java.io.PrintWriter |
out
Output stream to the console. |
static int |
SQL_EXCEPTION_EXIT_CODE
The code given to System.exit(int) when the program failed because of a
SQLException . |
Constructor Summary | |
---|---|
protected |
CommandLine(java.lang.String[] args)
Creates a new CommandLine instance from the given arguments. |
protected |
CommandLine(java.lang.String[] args,
int maximumRemaining)
Creates a new CommandLine instance from the given arguments. |
Method Summary | ||
---|---|---|
protected void |
help()
Prints a description of all arguments to the standard output. |
|
protected
|
parse(java.lang.Class<T> type,
java.lang.String value)
Parses the given string as a value of the given type. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ILLEGAL_ARGUMENT_EXIT_CODE
System.exit(int)
when the program failed because of an illegal
user argument.
public static final int ABORT_EXIT_CODE
System.exit(int)
when the program aborted at user request.
public static final int BAD_CONTENT_EXIT_CODE
System.exit(int)
when the program failed because of bad
content in a file.
public static final int IO_EXCEPTION_EXIT_CODE
System.exit(int)
when the program failed because of an
IOException
.
public static final int SQL_EXCEPTION_EXIT_CODE
System.exit(int)
when the program failed because of a
SQLException
.
protected final java.io.PrintWriter out
"-encoding"
argument, if presents.
protected final java.io.PrintWriter err
protected final java.util.Locale locale
"-locale"
option. If no such option was
provided, then this field is set to the default locale.
protected final java.lang.String[] arguments
Constructor Detail |
---|
protected CommandLine(java.lang.String[] args)
CommandLine
instance from the given arguments. This constructor
expects no additional argument after the one annoted as Option.
args
- The command-line arguments.protected CommandLine(java.lang.String[] args, int maximumRemaining)
CommandLine
instance from the given arguments. If this constructor
fails because of a programming error (for example a type not handled by parse
method), then an exception is thrown like usual. If this constructor fails because
of some user error (e.g. if a mandatory argument is not provided) or some other external
conditions (e.g. an IOException
), then it prints a short error message and invokes
System.exit(int)
with one the EXIT_CODE
constants.
args
- The command-line arguments.maximumRemaining
- The maximum number of arguments that may remain after processing
of annotated fields. This is the maximum length of the arguments
array.
The default value is 0.Method Detail |
---|
protected <T> T parse(java.lang.Class<T> type, java.lang.String value) throws java.lang.UnsupportedOperationException
T
- The field type.type
- The field type.value
- The value given on the command line.
java.lang.UnsupportedOperationException
- if the value can't be parsed.protected void help()
--help
argument on the command line. Subclasses can override this method in order to
prints a summary before the option list.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |