HBASE-25686 [hbtop] Add some javadoc

Signed-off-by: Wei-Chiu Chuang <weichiu@apache.org>
This commit is contained in:
Toshihiro Suzuki 2021-03-27 17:20:22 +09:00
parent 87527d62ad
commit 90a83f5a6a
4 changed files with 15 additions and 2 deletions

View File

@ -43,7 +43,10 @@ import org.apache.hadoop.hbase.hbtop.terminal.TerminalPrinter;
import org.apache.hadoop.hbase.hbtop.terminal.TerminalSize;
/**
* The implementation of the {@link Terminal} interface.
* An implementation of the {@link Terminal} interface for normal display mode.
*
* This implementation produces output intended for human viewing. In particular, it only displays
* one screenful of data. The output contains some escape sequences for formatting.
*/
@InterfaceAudience.Private
public class TerminalImpl implements Terminal {

View File

@ -26,7 +26,7 @@ import org.apache.hadoop.hbase.hbtop.terminal.Color;
import org.apache.hadoop.hbase.hbtop.terminal.TerminalPrinter;
/**
* The implementation of the {@link TerminalPrinter} interface.
* An implementation of the {@link TerminalPrinter} interface for normal display mode.
*/
@InterfaceAudience.Private
public class TerminalPrinterImpl extends AbstractTerminalPrinter {

View File

@ -24,6 +24,13 @@ import org.apache.hadoop.hbase.hbtop.terminal.Terminal;
import org.apache.hadoop.hbase.hbtop.terminal.TerminalPrinter;
import org.apache.hadoop.hbase.hbtop.terminal.TerminalSize;
/**
* An implementation of the {@link Terminal} interface for batch mode.
*
* This implementation produces output that's more sensible for collecting to a log file or for
* parsing. There is no limit on the number of output lines, and the output doesn't contain any
* escape sequences for formatting.
*/
public class BatchTerminal implements Terminal {
private static final TerminalPrinter TERMINAL_PRINTER = new BatchTerminalPrinter();

View File

@ -20,6 +20,9 @@ package org.apache.hadoop.hbase.hbtop.terminal.impl.batch;
import org.apache.hadoop.hbase.hbtop.terminal.AbstractTerminalPrinter;
import org.apache.hadoop.hbase.hbtop.terminal.TerminalPrinter;
/**
* An implementation of the {@link TerminalPrinter} interface for batch mode.
*/
public class BatchTerminalPrinter extends AbstractTerminalPrinter {
@Override