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
This commit is contained in:
Jim Kellerman 2008-11-07 04:44:36 +00:00
parent e408380bd1
commit f78f944026
3 changed files with 34 additions and 11 deletions

View File

@ -63,6 +63,7 @@ Release 0.19.0 - Unreleased
HBASE-964 Startup stuck "waiting for root region" HBASE-964 Startup stuck "waiting for root region"
HBASE-980 Undo core of HBASE-975, caching of start and end row 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-982 Deleting a column in MapReduce fails (Doğacan Güney via Stack)
HBASE-984 Fix javadoc warnings
IMPROVEMENTS IMPROVEMENTS
HBASE-901 Add a limit to key length, check key and value length on client side HBASE-901 Add a limit to key length, check key and value length on client side

View File

@ -27,17 +27,16 @@ import org.apache.hadoop.hbase.HRegionInfo;
import org.apache.hadoop.hbase.HStoreKey; import org.apache.hadoop.hbase.HStoreKey;
import org.apache.hadoop.hbase.io.Reference.Range; import org.apache.hadoop.hbase.io.Reference.Range;
import org.apache.hadoop.hbase.util.Writables; import org.apache.hadoop.hbase.util.Writables;
import org.apache.hadoop.io.MapFile;
import org.apache.hadoop.io.Writable; import org.apache.hadoop.io.Writable;
import org.apache.hadoop.io.WritableComparable; import org.apache.hadoop.io.WritableComparable;
/** /**
* A facade for a {@link MapFile.Reader} that serves up either the top or * A facade for a {@link org.apache.hadoop.io.MapFile.Reader} that serves up
* bottom half of a MapFile where 'bottom' is the first half of the file * either the top or bottom half of a MapFile where 'bottom' is the first half
* containing the keys that sort lowest and 'top' is the second half of the * of the file containing the keys that sort lowest and 'top' is the second half
* file with keys that sort greater than those of the bottom half. The top * of the file with keys that sort greater than those of the bottom half.
* includes the split files midkey, of the key that follows if it does not * The top includes the split files midkey, of the key that follows if it does
* exist in the file. * not exist in the file.
* *
* <p>This type works in tandem with the {@link Reference} type. This class * <p>This type works in tandem with the {@link Reference} type. This class
* is used reading while Reference is used writing. * is used reading while Reference is used writing.
@ -49,6 +48,15 @@ public class HalfMapFileReader extends BloomFilterMapFile.Reader {
private final HStoreKey midkey; private final HStoreKey midkey;
private boolean firstNextCall = true; 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, public HalfMapFileReader(final FileSystem fs, final String dirName,
final Configuration conf, final Range r, final Configuration conf, final Range r,
final WritableComparable<HStoreKey> mk, final WritableComparable<HStoreKey> mk,
@ -57,6 +65,17 @@ public class HalfMapFileReader extends BloomFilterMapFile.Reader {
this(fs, dirName, conf, r, mk, false, false, hri); 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") @SuppressWarnings("unchecked")
public HalfMapFileReader(final FileSystem fs, final String dirName, public HalfMapFileReader(final FileSystem fs, final String dirName,
final Configuration conf, final Range r, final Configuration conf, final Range r,
@ -94,6 +113,7 @@ public class HalfMapFileReader extends BloomFilterMapFile.Reader {
} }
} }
@SuppressWarnings("unchecked")
@Override @Override
public synchronized void finalKey(WritableComparable key) public synchronized void finalKey(WritableComparable key)
throws IOException { throws IOException {

View File

@ -39,9 +39,11 @@ public class InfoServer extends HttpServer {
* Create a status server on the given port. * Create a status server on the given port.
* The jsp scripts are taken from src/webapps/<code>name<code>. * The jsp scripts are taken from src/webapps/<code>name<code>.
* @param name The name of the server * @param name The name of the server
* @param bindAddress
* @param port The port to use on the server * @param port The port to use on the server
* @param findPort whether the server should start at the given port and * @param findPort whether the server should start at the given port and
* increment by 1 until it finds a free port. * increment by 1 until it finds a free port.
* @throws IOException
*/ */
public InfoServer(String name, String bindAddress, int port, boolean findPort) public InfoServer(String name, String bindAddress, int port, boolean findPort)
throws IOException { throws IOException {
@ -64,10 +66,10 @@ public class InfoServer extends HttpServer {
} }
/** /**
* Get the pathname to the <code>path</code> files. * Get the pathname to the <code>path</code> files.
* @param path Path to find. * @return the pathname as a URL
* @return the pathname as a URL */
*/ @Override
protected String getWebAppsPath() throws IOException { protected String getWebAppsPath() throws IOException {
// Hack: webapps is not a unique enough element to find in CLASSPATH // Hack: webapps is not a unique enough element to find in CLASSPATH
// We'll more than likely find the hadoop webapps dir. So, instead // We'll more than likely find the hadoop webapps dir. So, instead