org.h2.util.Tool Maven / Gradle / Ivy
/*
* Copyright 2004-2011 H2 Group. Multiple-Licensed under the H2 License,
* Version 1.0, and under the Eclipse Public License, Version 1.0
* (http://h2database.com/html/license.html).
* Initial Developer: H2 Group
*/
package org.h2.util;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.PrintStream;
import java.sql.SQLException;
import java.util.Properties;
import org.h2.constant.ErrorCode;
import org.h2.message.DbException;
import org.h2.store.FileLister;
import org.h2.store.fs.FileUtils;
/**
* Command line tools implement the tool interface so that they can be used in
* the H2 Console.
*/
public abstract class Tool {
/**
* The output stream where this tool writes to.
*/
protected PrintStream out = System.out;
private Properties resources;
/**
* Sets the standard output stream.
*
* @param out the new standard output stream
*/
public void setOut(PrintStream out) {
this.out = out;
}
/**
* Run the tool with the given output stream and arguments.
*
* @param args the argument list
*/
public abstract void runTool(String... args) throws SQLException;
/**
* Throw a SQLException saying this command line option is not supported.
*
* @param option the unsupported option
* @return this method never returns normally
*/
protected SQLException showUsageAndThrowUnsupportedOption(String option) throws SQLException {
showUsage();
throw throwUnsupportedOption(option);
}
/**
* Throw a SQLException saying this command line option is not supported.
*
* @param option the unsupported option
* @return this method never returns normally
*/
protected SQLException throwUnsupportedOption(String option) throws SQLException {
throw DbException.get(ErrorCode.FEATURE_NOT_SUPPORTED_1, option).getSQLException();
}
/**
* Print to the output stream that no database files have been found.
*
* @param dir the directory or null
* @param db the database name or null
*/
protected void printNoDatabaseFilesFound(String dir, String db) {
StringBuilder buff;
dir = FileLister.getDir(dir);
if (!FileUtils.isDirectory(dir)) {
buff = new StringBuilder("Directory not found: ");
buff.append(dir);
} else {
buff = new StringBuilder("No database files have been found");
buff.append(" in directory ").append(dir);
if (db != null) {
buff.append(" for the database ").append(db);
}
}
out.println(buff.toString());
}
/**
* Print the usage of the tool. This method reads the description from the
* resource file.
*/
protected void showUsage() {
if (resources == null) {
resources = new Properties();
String resourceName = "/org/h2/res/javadoc.properties";
try {
byte[] buff = Utils.getResource(resourceName);
if (buff != null) {
resources.load(new ByteArrayInputStream(buff));
}
} catch (IOException e) {
out.println("Cannot load " + resourceName);
}
}
String className = getClass().getName();
out.println(resources.get(className));
out.println("Usage: java "+getClass().getName() + " ");
out.println(resources.get(className + ".main"));
out.println("See also http://h2database.com/javadoc/" + className.replace('.', '/') + ".html");
}
/**
* Check if the argument matches the option.
* If the argument starts with this option, but doesn't match,
* then an exception is thrown.
*
* @param arg the argument
* @param option the command line option
* @return true if it matches
*/
public static boolean isOption(String arg, String option) {
if (arg.equals(option)) {
return true;
} else if (arg.startsWith(option)) {
throw DbException.getUnsupportedException("expected: " + option + " got: " + arg);
}
return false;
}
}