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..bb23daf 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 @@ -2167,7 +2167,7 @@ public class HBaseAdmin implements Abortable, Closeable { * {@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 + * Timestamp-consistent Snapshot} with {@link #snapshot(byte[], byte[])} or * {@link #snapshot(String, String)}, which creates a timestamp-based snapshot, causing minimal * interference with running cluster. *

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/procedure/Procedure.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/Procedure.java index af8f06d..2442fdc 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/Procedure.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/Procedure.java @@ -62,7 +62,8 @@ import com.google.common.collect.Lists; * amounts of time if one of the participants fails or takes a really long time (e.g. GC pause). *

* 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, ForeignExceptionListener { * Create a procedure. * * Users should generally not directly create instances of this. They are created them - * implicitly via {@link ProcedureCoordinator#createProcedure(String, byte[], List)}} + * implicitly via {@link ProcedureCoordinator#createProcedure(ForeignExceptionDispatcher, + * String, byte[], List)}} * * @param coord coordinator to call back to for general errors (e.g. * {@link ProcedureCoordinator#rpcConnectionFailure(String, IOException)}). @@ -257,7 +259,7 @@ public class Procedure implements Callable, ForeignExceptionListener { } /** - * Sends a message to members that all {@link Subprocedure#inBarrier} calls have completed. + * Sends a message to members that all {@link Subprocedure#insideBarrier} calls have completed. * After this executes, the coordinator can assume that any state resources about this barrier * procedure state has been released. */ diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureCoordinator.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureCoordinator.java index f87b2c4..e6d6fbe 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureCoordinator.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureCoordinator.java @@ -66,7 +66,6 @@ public class ProcedureCoordinator { * constructor. * * @param rpcs - * @param factory Builder for building Procedures * @param pool Used for executing procedures. */ public ProcedureCoordinator(ProcedureCoordinatorRpcs rpcs, ThreadPoolExecutor pool) { diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureCoordinatorRpcs.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureCoordinatorRpcs.java index d918d50..209c671 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureCoordinatorRpcs.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureCoordinatorRpcs.java @@ -68,7 +68,7 @@ public interface ProcedureCoordinatorRpcs extends Closeable { * Notify members that all members have acquired their parts of the barrier and that they can * now execute under the global barrier. * - * Must come after calling {@link #sendGlobalBarrierAcquire(String, byte[], List)} + * Must come after calling {@link #sendGlobalBarrierAcquire(Procedure, byte[], List)} * * @param procName name of the procedure to start * @param members members to tell we have reached in-barrier phase diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureMember.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureMember.java index 6db44a7..16575c5 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureMember.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureMember.java @@ -95,7 +95,7 @@ public class ProcedureMember implements Closeable { * sent here) * @param opName * @param data - * @return + * @return subprocedure */ public Subprocedure createSubprocedure(String opName, byte[] data) { return builder.buildSubprocedure(opName, data); @@ -214,7 +214,7 @@ public class ProcedureMember implements Closeable { /** * Send abort to the specified procedure * @param procName name of the procedure to about - * @param reason serialized information about the abort + * @param ee exception information about the abort */ public void receiveAbortProcedure(String procName, ForeignException ee) { // if we know about the procedure, notify it diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/Subprocedure.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/Subprocedure.java index 8e50409..9f2c504 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/Subprocedure.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/Subprocedure.java @@ -42,8 +42,8 @@ import org.apache.hadoop.hbase.errorhandling.TimeoutExceptionInjector; * Latches are use too block its progress and trigger continuations when barrier conditions are * met. * - * Exceptions that make it out from calls to {@link #acquireBarrier()} or {@link #insideBarrier()} - * get converted into {@link ExternalExceptions}, which will get propagated to the + * Exception that makes it out of calls to {@link #acquireBarrier()} or {@link #insideBarrier()} + * gets converted into {@link ForeignException}, which will get propagated to the * {@link ProcedureCoordinator}. * * There is a category of procedure (ex: online-snapshots), and a user-specified instance-specific @@ -144,11 +144,13 @@ abstract public class Subprocedure implements Callable { * This would normally be executed by the ProcedureMemeber when a acquire message comes from the * coordinator. Rpcs are used to spend message back to the coordinator after different phases * are executed. Any exceptions caught during the execution (except for InterrupedException) get - * converted and propagated to coordinator via {@link ProcedureMemberRpcs#sendAbort(Exception)}. + * converted and propagated to coordinator via {@link ProcedureMemberRpcs#sendMemberAborted( + * Subprocedure, ForeignException)}. */ @SuppressWarnings("finally") final public Void call() { - LOG.debug("Starting subprocedure '" + barrierName + "' with timeout " + executionTimeoutTimer.getMaxTime() + "ms"); + LOG.debug("Starting subprocedure '" + barrierName + "' with timeout " + + executionTimeoutTimer.getMaxTime() + "ms"); // start the execution timeout timer executionTimeoutTimer.start(); diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/SubprocedureFactory.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/SubprocedureFactory.java index d20f39e..0b94c89 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/SubprocedureFactory.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/SubprocedureFactory.java @@ -21,7 +21,7 @@ import org.apache.hadoop.classification.InterfaceAudience; import org.apache.hadoop.classification.InterfaceStability; /** - * Task builder to build instances of a {@link ProcedureMember}'s {@link Subporocedure}s. + * Task builder to build instances of a {@link ProcedureMember}'s {@link Subprocedure}s. */ @InterfaceAudience.Public @InterfaceStability.Evolving diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ZKProcedureCoordinatorRpcs.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ZKProcedureCoordinatorRpcs.java index 6e319ee..9132bbe 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ZKProcedureCoordinatorRpcs.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ZKProcedureCoordinatorRpcs.java @@ -49,7 +49,7 @@ public class ZKProcedureCoordinatorRpcs implements ProcedureCoordinatorRpcs { /** * @param watcher zookeeper watcher. Owned by this and closed via {@link #close()} - * @param procedureType procedure type name is a category for when there are multiple kinds of + * @param procedureClass procedure type name is a category for when there are multiple kinds of * procedures.-- this becomes a znode so be aware of the naming restrictions * @param coordName name of the node running the coordinator * @throws KeeperException if an unexpected zk error occurs 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 */