diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/client/HBaseAdmin.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/client/HBaseAdmin.java index 2870e23..84ff330 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/client/HBaseAdmin.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/client/HBaseAdmin.java @@ -2166,28 +2166,6 @@ public class HBaseAdmin implements Abortable, Closeable { * Snapshot names follow the same naming constraints as tables in HBase. See * {@link HTableDescriptor#isLegalTableName(byte[])}. *
- * Generally, you should not use this, but instead just take a {@link Type#TIMESTAMP - * Timestamp-consistentSnapshot} with {@link #snapshot(byte[], byte[])} or - * {@link #snapshot(String, String)}, which creates a timestamp-based snapshot, causing minimal - * interference with running cluster. - *
- * However, this method can be used to launch a {@link Type#GLOBAL GlobalSnapshot}. Note that a - * {@link Type#GLOBAL GlobalSnapshot}will block all writes to the table while taking the - * snapshot. This occurs so a single stable state can be achieved across all servers hosting the - * table - this is beyond the consistency constraints placed on an HBase table. This type of - * snapshot has two main implications: - *
- * This can be suitable for a smaller cluster, but comes with the above caveats - user beware (you - * should really consider if you can get by with just using timestamp-consistent snapshots via - * {@link #snapshot(byte[], byte[])}) or {@link #snapshot(String, String)}. * @param snapshotName name to give the snapshot on the filesystem. Must be unique from all other * snapshots stored on the cluster * @param tableName name of the table to snapshot diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/ForeignException.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/ForeignException.java index ca2feb5..06cd529 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/ForeignException.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/ForeignException.java @@ -148,7 +148,7 @@ public class ForeignException extends IOException { /** * Converts an ForeignException to a array of bytes. * @param source the name of the external exception source - * @param ee the "local" external exception (local) + * @param t the "local" external exception (local) * @return protobuf serialized version of ForeignThreadException */ public static byte[] serialize(String source, Throwable t) { diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/ForeignExceptionListener.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/ForeignExceptionListener.java index 61832a6..014da53 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/ForeignExceptionListener.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/ForeignExceptionListener.java @@ -34,8 +34,7 @@ public interface ForeignExceptionListener { * Receive a ForeignException. *
* Implementers must ensure that this method is thread-safe. - * @param message reason for the error - * @param e exception causing the error. Implementations must accept and handle null here. + * @param e exception causing the error. Implementations must accept and handle null here. */ public void receive(ForeignException e); } \ No newline at end of file diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/TimeoutExceptionInjector.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/TimeoutExceptionInjector.java index 25a1566..9f40cbf 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/TimeoutExceptionInjector.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/errorhandling/TimeoutExceptionInjector.java @@ -50,7 +50,6 @@ public class TimeoutExceptionInjector { * @param listener listener to notify if the process times out * @param maxTime max allowed running time for the process. Timer starts on calls to * {@link #start()} - * @param info information about the process to pass along if the timer expires */ public TimeoutExceptionInjector(final ForeignExceptionListener listener, final long maxTime) { this.maxTime = maxTime; diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/io/HLogLink.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/io/HLogLink.java index 91627ac..8feb8cb 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/io/HLogLink.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/io/HLogLink.java @@ -49,7 +49,7 @@ public class HLogLink extends FileLink { } /** - * @param rootdir Path to the root directory where hbase files are stored + * @param rootDir Path to the root directory where hbase files are stored * @param serverName Region Server owner of the log * @param logName WAL file name */ @@ -61,7 +61,7 @@ public class HLogLink extends FileLink { /** * @param originPath Path to the wal in the log directory - * @param archiveDir Path to the wal in the archived log directory + * @param archivePath Path to the wal in the archived log directory */ public HLogLink(final Path originPath, final Path archivePath) { setLocations(originPath, archivePath); diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/master/HMaster.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/HMaster.java index fa4e0b6..af5b01b 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/master/HMaster.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/HMaster.java @@ -2483,7 +2483,7 @@ Server { /** * Execute Delete Snapshot operation. - * @returns DeleteSnapshotResponse (a protobuf wrapped void) if the snapshot existed and was + * @return DeleteSnapshotResponse (a protobuf wrapped void) if the snapshot existed and was * deleted properly. * @throws ServiceException wrapping SnapshotDoesNotExistException if specified snapshot did not * exist. @@ -2507,7 +2507,7 @@ Server { /** * Checks if the specified snapshot is done. - * @returns true if the snapshot is in file system ready to use, + * @return true if the snapshot is in file system ready to use, * false if the snapshot is in the process of completing * @throws ServiceException wrapping UnknownSnapshotException if invalid snapshot, or * a wrapped HBaseSnapshotException with progress failure reason. diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/master/snapshot/DisabledTableSnapshotHandler.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/snapshot/DisabledTableSnapshotHandler.java index 030d809..403e0ab 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/master/snapshot/DisabledTableSnapshotHandler.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/snapshot/DisabledTableSnapshotHandler.java @@ -55,7 +55,6 @@ public class DisabledTableSnapshotHandler extends TakeSnapshotHandler { /** * @param snapshot descriptor of the snapshot to take - * @param server parent server * @param masterServices master services provider * @throws IOException on unexpected error */ diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/master/snapshot/MasterSnapshotVerifier.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/snapshot/MasterSnapshotVerifier.java index eca7ab5..862e7b8 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/master/snapshot/MasterSnapshotVerifier.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/snapshot/MasterSnapshotVerifier.java @@ -71,8 +71,6 @@ import org.apache.hadoop.hbase.util.HFileArchiveUtil; *
* Users should generally not directly create or subclass instances of this. They are created
- * for them implicitly via {@link ProcedureCoordinator#startProcedure(String, byte[], List)}}
+ * for them implicitly via {@link ProcedureCoordinator#startProcedure(ForeignExceptionDispatcher,
+ * String, byte[], List)}}
*/
@InterfaceAudience.Public
@InterfaceStability.Evolving
@@ -142,7 +143,8 @@ public class Procedure implements Callable
- * On instantiation, this ensures the procedure znodes exists. This however requires calling
- * {@link #start} to start monitoring for running procedures.
+ * On instantiation, this ensures the procedure znodes exist. This however requires the passed in
+ * watcher has been started.
* @param watcher watcher for the cluster ZK. Owned by this and closed via
* {@link #close()}
* @param procDescription name of the znode describing the procedure to run
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/ProtobufUtil.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/ProtobufUtil.java
index b761860..c974cfc 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/ProtobufUtil.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/ProtobufUtil.java
@@ -746,7 +746,7 @@ public final class ProtobufUtil {
* Create a new protocol buffer Exec based on a client Exec
*
* @param exec
- * @return
+ * @return protocol buffer Exec
* @throws IOException
*/
public static ClientProtos.Exec toExec(
@@ -1079,7 +1079,7 @@ public final class ProtobufUtil {
* Convert a delete KeyValue type to protocol buffer DeleteType.
*
* @param type
- * @return
+ * @return protocol buffer DeleteType
* @throws IOException
*/
public static DeleteType toDeleteType(
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/RequestConverter.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/RequestConverter.java
index 0218f2e..b3e211a 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/RequestConverter.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/RequestConverter.java
@@ -1051,7 +1051,7 @@ public final class RequestConverter {
/**
* Creates a protocol buffer GetSchemaAlterStatusRequest
*
- * @param tableName
+ * @param table
* @return a GetSchemaAlterStatusRequest
*/
public static GetSchemaAlterStatusRequest buildGetSchemaAlterStatusRequest(final byte [] table) {
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegion.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegion.java
index 53f1d67..47bc636 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegion.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegion.java
@@ -2022,7 +2022,6 @@ public class HRegion implements HeapSize { // , Writable{
/**
* Perform a batch put with no pre-specified locks
- * @see HRegion#put(Pair[])
*/
public OperationStatus[] put(Put[] puts) throws IOException {
@SuppressWarnings("unchecked")
@@ -2534,18 +2533,15 @@ public class HRegion implements HeapSize { // , Writable{
/**
* Complete taking the snapshot on the region. Writes the region info and adds references to the
* working snapshot directory.
- * @param desc snapshot being completed
- * @param exnSnare ForeignExceptionSnare that captures external exections in case we need to
- * bail out. This is allowed to be null and will just be ignored in that case.
- * @throws IOException if there is an external or internal error causing the snapshot to fail
*
* TODO for api consistency, consider adding another version with no {@link ForeignExceptionSnare}
* arg. (In the future other cancellable HRegion methods could eventually add a
* {@link ForeignExceptionSnare}, or we could do something fancier).
*
* @param desc snasphot description object
- * @param exnSnaprethe snare that used for reporting and checking for ForeignExceptions
- * @throws IOException thrown if ther are network or file system exceptions.
+ * @param exnSnare ForeignExceptionSnare that captures external exeptions in case we need to
+ * bail out. This is allowed to be null and will just be ignored in that case.
+ * @throws IOException if there is an external or internal error causing the snapshot to fail
*/
public void addRegionToSnapshot(SnapshotDescription desc,
ForeignExceptionSnare exnSnare) throws IOException {
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegionServer.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegionServer.java
index 62c908e..c82f20d 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegionServer.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegionServer.java
@@ -3749,7 +3749,8 @@ public class HRegionServer implements ClientProtocol,
*
* @param region
* @param mutate
- * @return
+ * @return result to return to client if default operation should be
+ * bypassed as indicated by RegionObserver, null otherwise
* @throws IOException
*/
protected Result append(final HRegion region,
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/snapshot/RegionServerSnapshotManager.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/snapshot/RegionServerSnapshotManager.java
index 723c97c..6317017 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/snapshot/RegionServerSnapshotManager.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/snapshot/RegionServerSnapshotManager.java
@@ -66,7 +66,7 @@ import com.google.protobuf.InvalidProtocolBufferException;
*
* On startup, requires {@link #start()} to be called.
*
- * On shutdown, requires {@link #close()} to be called
+ * On shutdown, requires {@link #stop(boolean)} to be called
*/
@InterfaceAudience.Private
@InterfaceStability.Unstable
@@ -115,8 +115,6 @@ public class RegionServerSnapshotManager {
/**
* Create a default snapshot handler - uses a zookeeper based cohort controller.
- * @param conf configuration to use for extracting information like thread pool properties and
- * frequency to check for errors (wake frequency).
* @param rss region server running the handler
* @throws KeeperException if the zookeeper cluster cannot be reached
*/
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/snapshot/RestoreSnapshotHelper.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/snapshot/RestoreSnapshotHelper.java
index e7bebe9..01ce1f0 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/snapshot/RestoreSnapshotHelper.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/snapshot/RestoreSnapshotHelper.java
@@ -551,7 +551,6 @@ public class RestoreSnapshotHelper {
/**
* Create a new table descriptor cloning the snapshot table schema.
*
- * @param admin
* @param snapshotTableDescriptor
* @param tableName
* @return cloned table descriptor
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/snapshot/SnapshotReferenceUtil.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/snapshot/SnapshotReferenceUtil.java
index d74310d..cb489d8 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/snapshot/SnapshotReferenceUtil.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/snapshot/SnapshotReferenceUtil.java
@@ -205,7 +205,6 @@ public final class SnapshotReferenceUtil {
*
* @param fs {@link FileSystem}
* @param snapshotDir {@link Path} to the Snapshot directory
- * @param visitor callback object to get the log files
* @throws IOException if an error occurred while scanning the directory
* @return the names of hfiles in the specified snaphot
*/