@@ -20,16 +20,31 @@ import java.sql.Connection; import java.sql.SQLException; /** - * + * The StackDumpHook prints a complete stack trace to a designated + * {@link PrintStream} every time it run. The stack traces are printed to + * {@link System#out} by default. + * <p> + * This hook is primarily for debugging purpose and you wouldn't want to use + * it in a production setting. * @author cvh */ public class StackDumpHook implements Hook { private final PrintStream out; + /** + * Create a StackDumpHook that prints a complete stack trace to System.out + * when it runs. + */ public StackDumpHook() { this(System.err); } + /** + * Create a StackDumpHook that prints a complete stack trace to the + * {@link PrintStream} specified as parameter. + * @param out The {@link PrintStream} to which the stack traces will be + * printed. + */ public StackDumpHook(PrintStream out) { this.out = out; } src/main/java/net/nanopool/hooks/StackDumpHook.java 1e9c15a48c045ed7bad3852ebeed19077a4869ff Christian Vest Hansen karmazilla@gmail.com http://github.com/karmazilla/nanopool/commit/32a0ca469586b1e3262ecbdab98f834dbf7ba419 32a0ca469586b1e3262ecbdab98f834dbf7ba419 2009-10-19T10:31:52-07:00 2009-10-19T10:31:52-07:00 javadoc for the StackDumpHook 856e9bdb9c6fa898cea1798b48dc6d02767c3628 Christian Vest Hansen karmazilla@gmail.com