Package org.h2.util
Class Tool
java.lang.Object
org.h2.util.Tool
- Direct Known Subclasses:
Backup
,ChangeFileEncryption
,Console
,ConvertTraceFile
,CreateCluster
,DeleteDbFiles
,Recover
,Restore
,RunScript
,Script
,Server
,Shell
Command line tools implement the tool interface so that they can be used in
the H2 Console.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected PrintStream
The output stream where this tool writes to.private Properties
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
Check if the argument matches the option.protected void
printNoDatabaseFilesFound
(String dir, String db) Print to the output stream that no database files have been found.abstract void
Run the tool with the given output stream and arguments.void
setOut
(PrintStream out) Sets the standard output stream.protected void
Print the usage of the tool.protected SQLException
Throw a SQLException saying this command line option is not supported.protected SQLException
throwUnsupportedOption
(String option) Throw a SQLException saying this command line option is not supported.
-
Field Details
-
out
The output stream where this tool writes to. -
resources
-
-
Constructor Details
-
Tool
public Tool()
-
-
Method Details
-
setOut
Sets the standard output stream.- Parameters:
out
- the new standard output stream
-
runTool
Run the tool with the given output stream and arguments.- Parameters:
args
- the argument list- Throws:
SQLException
- on failure
-
showUsageAndThrowUnsupportedOption
Throw a SQLException saying this command line option is not supported.- Parameters:
option
- the unsupported option- Returns:
- this method never returns normally
- Throws:
SQLException
- on failure
-
throwUnsupportedOption
Throw a SQLException saying this command line option is not supported.- Parameters:
option
- the unsupported option- Returns:
- this method never returns normally
- Throws:
SQLException
- on failure
-
printNoDatabaseFilesFound
Print to the output stream that no database files have been found.- Parameters:
dir
- the directory or nulldb
- the database name or null
-
showUsage
protected void showUsage()Print the usage of the tool. This method reads the description from the resource file. -
isOption
Check if the argument matches the option. If the argument starts with this option, but doesn't match, then an exception is thrown.- Parameters:
arg
- the argumentoption
- the command line option- Returns:
- true if it matches
-