Author: medined
Date: Thu Aug 2 00:49:34 2012
New Revision: 1368329
URL: http://svn.apache.org/viewvc?rev=1368329&view=rev
Log:
ACCUMULO-711 - javadoc cleanup
Modified:
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/Constants.java
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/blockfile/ABlockReader.java
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/blockfile/cache/BlockCache.java
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/rfile/BlockIndex.java
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
accumulo/trunk/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/EvaluatingIterator.java
Modified:
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/Constants.java
URL:
http://svn.apache.org/viewvc/accumulo/trunk/core/src/main/java/org/apache/accumulo/core/Constants.java?rev=1368329&r1=1368328&r2=1368329&view=diff
==============================================================================
--- accumulo/trunk/core/src/main/java/org/apache/accumulo/core/Constants.java
(original)
+++ accumulo/trunk/core/src/main/java/org/apache/accumulo/core/Constants.java
Thu Aug 2 00:49:34 2012
@@ -186,7 +186,7 @@ public class Constants {
/**
* @param conf
- * @return
+ * @return The write-ahead log directory.
*/
public static String getWalDirectory(AccumuloConfiguration conf) {
return getBaseDir(conf) + "/wal";
Modified:
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/blockfile/ABlockReader.java
URL:
http://svn.apache.org/viewvc/accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/blockfile/ABlockReader.java?rev=1368329&r1=1368328&r2=1368329&view=diff
==============================================================================
---
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/blockfile/ABlockReader.java
(original)
+++
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/blockfile/ABlockReader.java
Thu Aug 2 00:49:34 2012
@@ -37,10 +37,17 @@ public interface ABlockReader extends Da
/**
* An indexable block supports seeking, getting a position, and associating
an arbitrary index with the block
*
- * @return
+ * @return true, if the block is indexable; otherwise false.
*/
public boolean isIndexable();
+
public void seek(int position);
+
+ /** Get the file position.
+
+ * @return the file position.
+ */
public int getPosition();
+
<T> T getIndex(Class<T> clazz);
}
Modified:
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/blockfile/cache/BlockCache.java
URL:
http://svn.apache.org/viewvc/accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/blockfile/cache/BlockCache.java?rev=1368329&r1=1368328&r2=1368329&view=diff
==============================================================================
---
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/blockfile/cache/BlockCache.java
(original)
+++
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/blockfile/cache/BlockCache.java
Thu Aug 2 00:49:34 2012
@@ -60,7 +60,9 @@ public interface BlockCache {
public void shutdown();
/**
- * @return
+ * Get the maximum size of this cache.
+ *
+ * @return max size in bytes
*/
public long getMaxSize();
}
Modified:
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/rfile/BlockIndex.java
URL:
http://svn.apache.org/viewvc/accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/rfile/BlockIndex.java?rev=1368329&r1=1368328&r2=1368329&view=diff
==============================================================================
---
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/rfile/BlockIndex.java
(original)
+++
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/file/rfile/BlockIndex.java
Thu Aug 2 00:49:34 2012
@@ -68,7 +68,7 @@ public class BlockIndex {
}
/**
- * @param startKey
+ * @param key
*/
public BlockIndexEntry(Key key) {
this.key = key;
Modified:
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
URL:
http://svn.apache.org/viewvc/accumulo/trunk/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java?rev=1368329&r1=1368328&r2=1368329&view=diff
==============================================================================
---
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
(original)
+++
accumulo/trunk/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
Thu Aug 2 00:49:34 2012
@@ -82,11 +82,11 @@ public interface SortedKeyValueIterator<
* to a key in the middle of such a group (e.g. the middle of a row). Even
if the client always seeks to a range containing an entire group (a,c), the
tablet
* server could send back a batch of entries corresponding to (a,b], then
reseek the iterator to range (b,c) when the scan is continued.
*
- * {@link columnFamilies} is used, at the lowest level, to determine which
data blocks inside of an RFile need to be opened for this iterator. This set of
data
+ * {@code columnFamilies} is used, at the lowest level, to determine which
data blocks inside of an RFile need to be opened for this iterator. This set of
data
* blocks is also the set of locality groups defined for the given table. If
no columnFamilies are provided, the data blocks for all locality groups inside
of
- * the correct RFile will be opened and seeked in an attempt to find the
correct start key, irregardless of the startKey in the {@link range}.
+ * the correct RFile will be opened and seeked in an attempt to find the
correct start key, irregardless of the startKey in the {@code range}.
*
- * In an Accumulo instance in which multiple locality groups exist for a
table, it is important to ensure that {@link columnFamilies} is properly set to
the
+ * In an Accumulo instance in which multiple locality groups exist for a
table, it is important to ensure that {@code columnFamilies} is properly set to
the
* minimum required column families to ensure that data from separate
locality groups is not inadvertently read.
*
* @param range
Modified:
accumulo/trunk/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/EvaluatingIterator.java
URL:
http://svn.apache.org/viewvc/accumulo/trunk/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/EvaluatingIterator.java?rev=1368329&r1=1368328&r2=1368329&view=diff
==============================================================================
---
accumulo/trunk/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/EvaluatingIterator.java
(original)
+++
accumulo/trunk/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/EvaluatingIterator.java
Thu Aug 2 00:49:34 2012
@@ -85,7 +85,7 @@ public class EvaluatingIterator extends
/**
* @param key
- * @return
+ * @return The column visibility
*/
public ColumnVisibility getColumnVisibility(Key key) {
ColumnVisibility result = (ColumnVisibility)
visibilityMap.get(key.getColumnVisibility());
