From f78f944026075f7fd22a1f1dbfb7f7e8ac8f2364 Mon Sep 17 00:00:00 2001 From: Jim Kellerman Date: Fri, 7 Nov 2008 04:44:36 +0000 Subject: [PATCH] HBASE-984 Fix javadoc warnings This is probably the first of several patches to fix javadoc warnings. Jira issue will remain open until we create the release candidate. git-svn-id: https://svn.apache.org/repos/asf/hadoop/hbase/trunk@712055 13f79535-47bb-0310-9956-ffa450edef68 --- CHANGES.txt | 1 + .../hadoop/hbase/io/HalfMapFileReader.java | 34 +++++++++++++++---- .../apache/hadoop/hbase/util/InfoServer.java | 10 +++--- 3 files changed, 34 insertions(+), 11 deletions(-) diff --git a/CHANGES.txt b/CHANGES.txt index 04be4da4846..9ec6294dd5b 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -63,6 +63,7 @@ Release 0.19.0 - Unreleased HBASE-964 Startup stuck "waiting for root region" HBASE-980 Undo core of HBASE-975, caching of start and end row HBASE-982 Deleting a column in MapReduce fails (Doğacan Güney via Stack) + HBASE-984 Fix javadoc warnings IMPROVEMENTS HBASE-901 Add a limit to key length, check key and value length on client side diff --git a/src/java/org/apache/hadoop/hbase/io/HalfMapFileReader.java b/src/java/org/apache/hadoop/hbase/io/HalfMapFileReader.java index 178d8c798dd..7ae9447084f 100644 --- a/src/java/org/apache/hadoop/hbase/io/HalfMapFileReader.java +++ b/src/java/org/apache/hadoop/hbase/io/HalfMapFileReader.java @@ -27,17 +27,16 @@ import org.apache.hadoop.hbase.HRegionInfo; import org.apache.hadoop.hbase.HStoreKey; import org.apache.hadoop.hbase.io.Reference.Range; import org.apache.hadoop.hbase.util.Writables; -import org.apache.hadoop.io.MapFile; import org.apache.hadoop.io.Writable; import org.apache.hadoop.io.WritableComparable; /** - * A facade for a {@link MapFile.Reader} that serves up either the top or - * bottom half of a MapFile where 'bottom' is the first half of the file - * containing the keys that sort lowest and 'top' is the second half of the - * file with keys that sort greater than those of the bottom half. The top - * includes the split files midkey, of the key that follows if it does not - * exist in the file. + * A facade for a {@link org.apache.hadoop.io.MapFile.Reader} that serves up + * either the top or bottom half of a MapFile where 'bottom' is the first half + * of the file containing the keys that sort lowest and 'top' is the second half + * of the file with keys that sort greater than those of the bottom half. + * The top includes the split files midkey, of the key that follows if it does + * not exist in the file. * *

This type works in tandem with the {@link Reference} type. This class * is used reading while Reference is used writing. @@ -49,6 +48,15 @@ public class HalfMapFileReader extends BloomFilterMapFile.Reader { private final HStoreKey midkey; private boolean firstNextCall = true; + /** + * @param fs + * @param dirName + * @param conf + * @param r + * @param mk + * @param hri + * @throws IOException + */ public HalfMapFileReader(final FileSystem fs, final String dirName, final Configuration conf, final Range r, final WritableComparable mk, @@ -57,6 +65,17 @@ public class HalfMapFileReader extends BloomFilterMapFile.Reader { this(fs, dirName, conf, r, mk, false, false, hri); } + /** + * @param fs + * @param dirName + * @param conf + * @param r + * @param mk + * @param filter + * @param blockCacheEnabled + * @param hri + * @throws IOException + */ @SuppressWarnings("unchecked") public HalfMapFileReader(final FileSystem fs, final String dirName, final Configuration conf, final Range r, @@ -94,6 +113,7 @@ public class HalfMapFileReader extends BloomFilterMapFile.Reader { } } + @SuppressWarnings("unchecked") @Override public synchronized void finalKey(WritableComparable key) throws IOException { diff --git a/src/java/org/apache/hadoop/hbase/util/InfoServer.java b/src/java/org/apache/hadoop/hbase/util/InfoServer.java index dfe65d83615..3e16ea87555 100644 --- a/src/java/org/apache/hadoop/hbase/util/InfoServer.java +++ b/src/java/org/apache/hadoop/hbase/util/InfoServer.java @@ -39,9 +39,11 @@ public class InfoServer extends HttpServer { * Create a status server on the given port. * The jsp scripts are taken from src/webapps/name. * @param name The name of the server + * @param bindAddress * @param port The port to use on the server * @param findPort whether the server should start at the given port and * increment by 1 until it finds a free port. + * @throws IOException */ public InfoServer(String name, String bindAddress, int port, boolean findPort) throws IOException { @@ -64,10 +66,10 @@ public class InfoServer extends HttpServer { } /** - * Get the pathname to the path files. - * @param path Path to find. - * @return the pathname as a URL - */ + * Get the pathname to the path files. + * @return the pathname as a URL + */ + @Override protected String getWebAppsPath() throws IOException { // Hack: webapps is not a unique enough element to find in CLASSPATH // We'll more than likely find the hadoop webapps dir. So, instead