You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by br...@apache.org on 2021/03/27 08:20:51 UTC
[hbase] branch master updated: HBASE-25686 [hbtop] Add some javadoc
(#3096)
This is an automated email from the ASF dual-hosted git repository.
brfrn169 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hbase.git
The following commit(s) were added to refs/heads/master by this push:
new b062598 HBASE-25686 [hbtop] Add some javadoc (#3096)
b062598 is described below
commit b0625984f2a1db8c246112b14bb228e83234d25f
Author: Toshihiro Suzuki <br...@gmail.com>
AuthorDate: Sat Mar 27 17:20:22 2021 +0900
HBASE-25686 [hbtop] Add some javadoc (#3096)
Signed-off-by: Wei-Chiu Chuang <we...@apache.org>
---
.../org/apache/hadoop/hbase/hbtop/terminal/impl/TerminalImpl.java | 6 ++++--
.../hadoop/hbase/hbtop/terminal/impl/TerminalPrinterImpl.java | 3 +--
.../hadoop/hbase/hbtop/terminal/impl/batch/BatchTerminal.java | 7 +++++++
.../hbase/hbtop/terminal/impl/batch/BatchTerminalPrinter.java | 3 +++
4 files changed, 15 insertions(+), 4 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 ed71523..c6b74af 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
@@ -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 {
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 6ad7bdc..788d267 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
@@ -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 {
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 db7a9e7..6031666 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
@@ -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