Apache
/
hbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HBASE-7363 Fix javadocs warnings for hbase-server packages from master to end; ADDENDUM 

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1423581 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack 2012-12-18 19:07:34 +00:00
parent 115a8fd439
commit e21c9fde83
19 changed files with 36 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hbase-server/src/main/java/org/apache/hadoop/hbase/master/GeneralBulkAssigner.java
View File

@ -38,7 +38,7 @@ import org.apache.hadoop.hbase.ServerName;
/** /**
* Run bulk assign. Does one RCP per regionserver passing a * Run bulk assign. Does one RCP per regionserver passing a
* batch of regions using {@link SingleServerBulkAssigner}. * batch of regions using {@link GeneralBulkAssigner.SingleServerBulkAssigner}.
*/ */
@InterfaceAudience.Private @InterfaceAudience.Private
public class GeneralBulkAssigner extends BulkAssigner { public class GeneralBulkAssigner extends BulkAssigner {

4
hbase-server/src/main/java/org/apache/hadoop/hbase/master/cleaner/TimeToLiveHFileCleaner.java
View File

@ -30,7 +30,7 @@ import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;
/** /**
* HFile cleaner that uses the timestamp of the hfile to determine if it should be deleted. By * HFile cleaner that uses the timestamp of the hfile to determine if it should be deleted. By
* default they are allowed to live for {@value TimeToLiveHFileCleaner#DEFAULT_TTL} * default they are allowed to live for {@value #DEFAULT_TTL}
*/ */
@InterfaceAudience.Private @InterfaceAudience.Private
public class TimeToLiveHFileCleaner extends BaseHFileCleanerDelegate { public class TimeToLiveHFileCleaner extends BaseHFileCleanerDelegate {
@ -38,7 +38,7 @@ public class TimeToLiveHFileCleaner extends BaseHFileCleanerDelegate {
public static final Log LOG = LogFactory.getLog(TimeToLiveHFileCleaner.class.getName()); public static final Log LOG = LogFactory.getLog(TimeToLiveHFileCleaner.class.getName());
public static final String TTL_CONF_KEY = "hbase.master.hfilecleaner.ttl"; public static final String TTL_CONF_KEY = "hbase.master.hfilecleaner.ttl";
// default ttl = 5 minutes // default ttl = 5 minutes
private static final long DEFAULT_TTL = 60000 * 5; public static final long DEFAULT_TTL = 60000 * 5;
// Configured time a hfile can be kept after it was moved to the archive // Configured time a hfile can be kept after it was moved to the archive
private long ttl; private long ttl;
private FileSystem fs; private FileSystem fs;

4
hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/ProtobufUtil.java
View File

@ -746,7 +746,7 @@ public final class ProtobufUtil {
* Create a new protocol buffer Exec based on a client Exec * Create a new protocol buffer Exec based on a client Exec
* *
* @param exec * @param exec
* @return * @return a ClientProtos.Exec
* @throws IOException * @throws IOException
*/ */
public static ClientProtos.Exec toExec( public static ClientProtos.Exec toExec(
@ -1079,7 +1079,7 @@ public final class ProtobufUtil {
* Convert a delete KeyValue type to protocol buffer DeleteType. * Convert a delete KeyValue type to protocol buffer DeleteType.
* *
* @param type * @param type
* @return * @return a DeleteType
* @throws IOException * @throws IOException
*/ */
public static DeleteType toDeleteType( public static DeleteType toDeleteType(

5
hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/RequestConverter.java
View File

@ -1054,9 +1054,10 @@ public final class RequestConverter {
* @param tableName * @param tableName
* @return a GetSchemaAlterStatusRequest * @return a GetSchemaAlterStatusRequest
*/ */
public static GetSchemaAlterStatusRequest buildGetSchemaAlterStatusRequest(final byte [] table) { public static GetSchemaAlterStatusRequest buildGetSchemaAlterStatusRequest(
final byte [] tableName) {
GetSchemaAlterStatusRequest.Builder builder = GetSchemaAlterStatusRequest.newBuilder(); GetSchemaAlterStatusRequest.Builder builder = GetSchemaAlterStatusRequest.newBuilder();
builder.setTableName(ByteString.copyFrom(table)); builder.setTableName(ByteString.copyFrom(tableName));
return builder.build(); return builder.build();
} }

4
hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegion.java
View File

@ -1849,7 +1849,7 @@ public class HRegion implements HeapSize { // , Writable{
* Setup correct timestamps in the KVs in Delete object. * Setup correct timestamps in the KVs in Delete object.
* Caller should have the row and region locks. * Caller should have the row and region locks.
* @param familyMap * @param familyMap
* @param now * @param byteNow
* @throws IOException * @throws IOException
*/ */
void prepareDeleteTimestamps(Map<byte[], List<KeyValue>> familyMap, byte[] byteNow) void prepareDeleteTimestamps(Map<byte[], List<KeyValue>> familyMap, byte[] byteNow)
@ -1990,7 +1990,7 @@ public class HRegion implements HeapSize { // , Writable{
/** /**
* Perform a batch put with no pre-specified locks * Perform a batch put with no pre-specified locks
* @see HRegion#put(Pair[]) * @see HRegion#batchMutate(Pair[])
*/ */
public OperationStatus[] put(Put[] puts) throws IOException { public OperationStatus[] put(Put[] puts) throws IOException {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")

9
hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegionServer.java
View File

@ -1403,8 +1403,8 @@ public class HRegionServer implements ClientProtocol,
/** /**
* Called by {@link #setupWALAndReplication()} creating WAL instance. * Called by {@link #setupWALAndReplication()} creating WAL instance.
* @param logdir * @param rootdir
* @param oldLogDir * @param logName
* @return WAL instance. * @return WAL instance.
* @throws IOException * @throws IOException
*/ */
@ -1967,7 +1967,6 @@ public class HRegionServer implements ClientProtocol,
* For tests, web ui and metrics. * For tests, web ui and metrics.
* This method will only work if HRegionServer is in the same JVM as client; * This method will only work if HRegionServer is in the same JVM as client;
* HRegion cannot be serialized to cross an rpc. * HRegion cannot be serialized to cross an rpc.
* @see #getOnlineRegions()
*/ */
public Collection<HRegion> getOnlineRegionsLocalContext() { public Collection<HRegion> getOnlineRegionsLocalContext() {
Collection<HRegion> regions = this.onlineRegions.values(); Collection<HRegion> regions = this.onlineRegions.values();
@ -3723,7 +3722,7 @@ public class HRegionServer implements ClientProtocol,
* *
* @param region * @param region
* @param mutate * @param mutate
* @return * @return the Result
* @throws IOException * @throws IOException
*/ */
protected Result append(final HRegion region, protected Result append(final HRegion region,
@ -3750,7 +3749,7 @@ public class HRegionServer implements ClientProtocol,
* *
* @param region * @param region
* @param mutate * @param mutate
* @return * @return the Result
* @throws IOException * @throws IOException
*/ */
protected Result increment(final HRegion region, protected Result increment(final HRegion region,

2
hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RegionCoprocessorHost.java
View File

@ -524,7 +524,7 @@ public class RegionCoprocessorHost
/** /**
* See * See
* {@link RegionObserver#preFlush(ObserverContext<RegionCoprocessorEnvironment>, HStore, KeyValueScanner)} * {@link RegionObserver#preFlushScannerOpen(ObserverContext, HStore, KeyValueScanner, InternalScanner)}
*/ */
public InternalScanner preFlushScannerOpen(HStore store, KeyValueScanner memstoreScanner) throws IOException { public InternalScanner preFlushScannerOpen(HStore store, KeyValueScanner memstoreScanner) throws IOException {
ObserverContext<RegionCoprocessorEnvironment> ctx = null; ObserverContext<RegionCoprocessorEnvironment> ctx = null;

3
hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RegionSplitPolicy.java
View File

@ -91,10 +91,9 @@ public abstract class RegionSplitPolicy extends Configured {
/** /**
* Create the RegionSplitPolicy configured for the given table. * Create the RegionSplitPolicy configured for the given table.
* Each
* @param region * @param region
* @param conf * @param conf
* @return * @return a RegionSplitPolicy
* @throws IOException * @throws IOException
*/ */
public static RegionSplitPolicy create(HRegion region, public static RegionSplitPolicy create(HRegion region,

2
hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RowProcessor.java
View File

@ -119,7 +119,7 @@ public interface RowProcessor<S extends Message, T extends Message> {
/** /**
* This method should return any additional data that is needed on the * This method should return any additional data that is needed on the
* server side to construct the RowProcessor. The server will pass this to * server side to construct the RowProcessor. The server will pass this to
* the {@link #initialize(ByteString)} method. If there is no RowProcessor * the {@link #initialize(Message msg)} method. If there is no RowProcessor
* specific data then null should be returned. * specific data then null should be returned.
* @return the PB message * @return the PB message
* @throws IOException * @throws IOException

2
hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/StoreFileScanner.java
View File

@ -219,7 +219,7 @@ public class StoreFileScanner implements KeyValueScanner {
* *
* @param s * @param s
* @param k * @param k
* @return * @return false if not found or if k is after the end.
* @throws IOException * @throws IOException
*/ */
public static boolean seekAtOrAfter(HFileScanner s, KeyValue k) public static boolean seekAtOrAfter(HFileScanner s, KeyValue k)

2
hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/compactions/CompactionRequest.java
View File

@ -89,7 +89,7 @@ public class CompactionRequest implements Comparable<CompactionRequest>,
* Find out if a given region is in compaction now. * Find out if a given region is in compaction now.
* *
* @param regionId * @param regionId
* @return * @return a CompactionState
*/ */
public static CompactionState getCompactionState( public static CompactionState getCompactionState(
final long regionId) { final long regionId) {

2
hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/SequenceFileLogWriter.java
View File

@ -40,7 +40,7 @@ import org.apache.hadoop.io.compress.CompressionCodec;
import org.apache.hadoop.io.compress.DefaultCodec; import org.apache.hadoop.io.compress.DefaultCodec;
/** /**
* Implementation of {@link FSHLog.Writer} that delegates to * Implementation of {@link HLog.Writer} that delegates to
* SequenceFile.Writer. * SequenceFile.Writer.
*/ */
@InterfaceAudience.Private @InterfaceAudience.Private

8
hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessControlLists.java
View File

@ -71,11 +71,11 @@ import java.util.*;
* Key Desc * Key Desc
* -------- -------- * -------- --------
* user table level permissions for a user [R=read, W=write] * user table level permissions for a user [R=read, W=write]
* @group table level permissions for a group * group table level permissions for a group
* user,family column family level permissions for a user * user,family column family level permissions for a user
* @group,family column family level permissions for a group * group,family column family level permissions for a group
* user,family,qualifier column qualifier level permissions for a user * user,family,qualifier column qualifier level permissions for a user
* @group,family,qualifier column qualifier level permissions for a group * group,family,qualifier column qualifier level permissions for a group
* </pre> * </pre>
* All values are encoded as byte arrays containing the codes from the * All values are encoded as byte arrays containing the codes from the
* {@link org.apache.hadoop.hbase.security.access.TablePermission.Action} enum. * {@link org.apache.hadoop.hbase.security.access.TablePermission.Action} enum.
@ -302,7 +302,7 @@ public class AccessControlLists {
* table. * table.
* *
* @param aclRegion * @param aclRegion
* @return * @return a map of the permissions for this table.
* @throws IOException * @throws IOException
*/ */
static Map<byte[],ListMultimap<String,TablePermission>> loadAll( static Map<byte[],ListMultimap<String,TablePermission>> loadAll(

2
hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessControllerProtocol.java
View File

@ -59,7 +59,7 @@ public interface AccessControllerProtocol extends CoprocessorProtocol {
* table, column family and column qualifier must all be specified. * table, column family and column qualifier must all be specified.
* Attempting to revoke permissions over just the "data" table will have * Attempting to revoke permissions over just the "data" table will have
* no effect. * no effect.
* @param permission the details of the previously granted permission to revoke * @param userPermission the details of the previously granted permission to revoke
* @throws IOException if the revocation could not be performed * @throws IOException if the revocation could not be performed
*/ */
public void revoke(UserPermission userPermission) public void revoke(UserPermission userPermission)

6
hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/TableAuthManager.java
View File

@ -244,7 +244,7 @@ public class TableAuthManager {
* user's groups. * user's groups.
* @param user * @param user
* @param action * @param action
* @return * @return true if known and authorized, false otherwise
*/ */
public boolean authorize(User user, Permission.Action action) { public boolean authorize(User user, Permission.Action action) {
if (user == null) { if (user == null) {
@ -339,7 +339,7 @@ public class TableAuthManager {
* @param table * @param table
* @param family * @param family
* @param action * @param action
* @return * @return true if known and authorized, false otherwise
*/ */
public boolean authorizeUser(String username, byte[] table, byte[] family, public boolean authorizeUser(String username, byte[] table, byte[] family,
Permission.Action action) { Permission.Action action) {
@ -372,7 +372,7 @@ public class TableAuthManager {
* @param table * @param table
* @param family * @param family
* @param action * @param action
* @return * @return true if known and authorized, false otherwise
*/ */
public boolean authorizeGroup(String groupName, byte[] table, byte[] family, public boolean authorizeGroup(String groupName, byte[] table, byte[] family,
Permission.Action action) { Permission.Action action) {

4
hbase-server/src/main/java/org/apache/hadoop/hbase/util/FSUtils.java
View File

@ -1265,7 +1265,7 @@ public abstract class FSUtils {
* @param fs * @param fs
* @param path * @param path
* @param recursive * @param recursive
* @return * @return the value returned by the fs.delete()
* @throws IOException * @throws IOException
*/ */
public static boolean delete(final FileSystem fs, final Path path, final boolean recursive) public static boolean delete(final FileSystem fs, final Path path, final boolean recursive)
@ -1278,7 +1278,7 @@ public abstract class FSUtils {
* *
* @param fs * @param fs
* @param path * @param path
* @return * @return the value returned by fs.exists()
* @throws IOException * @throws IOException
*/ */
public static boolean isExists(final FileSystem fs, final Path path) throws IOException { public static boolean isExists(final FileSystem fs, final Path path) throws IOException {

3
hbase-server/src/main/java/org/apache/hadoop/hbase/zookeeper/RootRegionTracker.java
View File

@ -28,8 +28,7 @@ import org.apache.zookeeper.KeeperException;
/** /**
* Tracks the root region server location node in zookeeper. * Tracks the root region server location node in zookeeper.
* Root region location is set by {@link RootLocationEditor} usually called * Root region location is set by <code>RegionServerServices</code>.
* out of <code>RegionServerServices</code>.
* This class has a watcher on the root location and notices changes. * This class has a watcher on the root location and notices changes.
*/ */
@InterfaceAudience.Private @InterfaceAudience.Private

8
hbase-server/src/main/java/org/apache/hadoop/hbase/zookeeper/ZKTableReadOnly.java
View File

@ -43,7 +43,7 @@ public class ZKTableReadOnly {
private ZKTableReadOnly() {} private ZKTableReadOnly() {}
/** /**
* Go to zookeeper and see if state of table is {@link ZooKeeperProtos.Table.State#DISABLED}. * Go to zookeeper and see if state of table is {@code ZooKeeperProtos.Table.State#DISABLED}.
* This method does not use cache. * This method does not use cache.
* This method is for clients other than {@link AssignmentManager} * This method is for clients other than {@link AssignmentManager}
* @param zkw * @param zkw
@ -59,7 +59,7 @@ public class ZKTableReadOnly {
} }
/** /**
* Go to zookeeper and see if state of table is {@link ZooKeeperProtos.Table.State#ENABLED}. * Go to zookeeper and see if state of table is {@code ZooKeeperProtos.Table.State#ENABLED}.
* This method does not use cache. * This method does not use cache.
* This method is for clients other than {@link AssignmentManager} * This method is for clients other than {@link AssignmentManager}
* @param zkw * @param zkw
@ -74,8 +74,8 @@ public class ZKTableReadOnly {
} }
/** /**
* Go to zookeeper and see if state of table is {@link ZooKeeperProtos.Table.State#DISABLING} * Go to zookeeper and see if state of table is {@code ZooKeeperProtos.Table.State#DISABLING}
* of {@link ZooKeeperProtos.Table.State#DISABLED}. * of {@code ZooKeeperProtos.Table.State#DISABLED}.
* This method does not use cache. * This method does not use cache.
* This method is for clients other than {@link AssignmentManager}. * This method is for clients other than {@link AssignmentManager}.
* @param zkw * @param zkw

2
pom.xml
View File

@ -868,7 +868,7 @@
<jamon.plugin.version>2.3.4</jamon.plugin.version> <jamon.plugin.version>2.3.4</jamon.plugin.version>
<findbugs.version>2.4.0</findbugs.version> <findbugs.version>2.4.0</findbugs.version>
<maven.site.version>3.1</maven.site.version> <maven.site.version>3.1</maven.site.version>
<javadoc.version>2.8.1</javadoc.version> <javadoc.version>2.9</javadoc.version>
<maven.resources.plugin.version>2.5</maven.resources.plugin.version> <maven.resources.plugin.version>2.5</maven.resources.plugin.version>
<!-- General Packaging --> <!-- General Packaging -->
<package.prefix>/usr</package.prefix> <package.prefix>/usr</package.prefix>