This is an automated email from the ASF dual-hosted git repository.
brfrn169 pushed a commit to branch branch-1
in repository https://gitbox.apache.org/repos/asf/hbase.git
The following commit(s) were added to refs/heads/branch-1 by this push:
new 90a83f5 HBASE-25686 [hbtop] Add some javadoc
90a83f5 is described below
commit 90a83f5a6ab96c12d09f83f18862d3eedfdfc52b
Author: Toshihiro Suzuki <[email protected]>
AuthorDate: Sat Mar 27 17:20:22 2021 +0900
HBASE-25686 [hbtop] Add some javadoc
Signed-off-by: Wei-Chiu Chuang <[email protected]>
---
.../org/apache/hadoop/hbase/hbtop/terminal/impl/TerminalImpl.java | 5 ++++-
.../hadoop/hbase/hbtop/terminal/impl/TerminalPrinterImpl.java | 2 +-
.../hadoop/hbase/hbtop/terminal/impl/batch/BatchTerminal.java | 7 +++++++
.../hbase/hbtop/terminal/impl/batch/BatchTerminalPrinter.java | 3 +++
4 files changed, 15 insertions(+), 2 deletions(-)
diff --git
a/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/TerminalImpl.java
b/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/TerminalImpl.java
index 0084e23..4fd8aca 100644
---
a/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/TerminalImpl.java
+++
b/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/TerminalImpl.java
@@ -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 {
diff --git
a/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/TerminalPrinterImpl.java
b/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/TerminalPrinterImpl.java
index 0d698b0..3e8c6a2 100644
---
a/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/TerminalPrinterImpl.java
+++
b/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/TerminalPrinterImpl.java
@@ -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 {
diff --git
a/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/batch/BatchTerminal.java
b/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/batch/BatchTerminal.java
index 19d6426..60f5502 100644
---
a/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/batch/BatchTerminal.java
+++
b/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/batch/BatchTerminal.java
@@ -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();
diff --git
a/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/batch/BatchTerminalPrinter.java
b/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/batch/BatchTerminalPrinter.java
index afae5e8..4864e07 100644
---
a/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/batch/BatchTerminalPrinter.java
+++
b/hbase-hbtop/src/main/java/org/apache/hadoop/hbase/hbtop/terminal/impl/batch/BatchTerminalPrinter.java
@@ -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
