HBASE-25686 [hbtop] Add some javadoc (#3096)
Signed-off-by: Wei-Chiu Chuang <weichiu@apache.org>
This commit is contained in:
parent
1e4639d2eb
commit
b0625984f2
|
@ -42,9 +42,11 @@ import org.apache.yetus.audience.InterfaceAudience;
|
|||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
|
||||
/**
|
||||
* 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 {
|
||||
|
|
|
@ -23,9 +23,8 @@ import org.apache.hadoop.hbase.hbtop.terminal.Color;
|
|||
import org.apache.hadoop.hbase.hbtop.terminal.TerminalPrinter;
|
||||
import org.apache.yetus.audience.InterfaceAudience;
|
||||
|
||||
|
||||
/**
|
||||
* The implementation of the {@link TerminalPrinter} interface.
|
||||
* An implementation of the {@link TerminalPrinter} interface for normal display mode.
|
||||
*/
|
||||
@InterfaceAudience.Private
|
||||
public class TerminalPrinterImpl implements TerminalPrinter {
|
||||
|
|
|
@ -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();
|
||||
|
|
|
@ -19,6 +19,9 @@ package org.apache.hadoop.hbase.hbtop.terminal.impl.batch;
|
|||
|
||||
import org.apache.hadoop.hbase.hbtop.terminal.TerminalPrinter;
|
||||
|
||||
/**
|
||||
* An implementation of the {@link TerminalPrinter} interface for batch mode.
|
||||
*/
|
||||
public class BatchTerminalPrinter implements TerminalPrinter {
|
||||
|
||||
@Override
|
||||
|
|
Loading…
Reference in New Issue