You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by db...@apache.org on 2015/12/28 21:15:35 UTC
cassandra git commit: minor javadoc fixes
Repository: cassandra
Updated Branches:
refs/heads/trunk bc6ea03d1 -> 6536c05b4
minor javadoc fixes
Project: http://git-wip-us.apache.org/repos/asf/cassandra/repo
Commit: http://git-wip-us.apache.org/repos/asf/cassandra/commit/6536c05b
Tree: http://git-wip-us.apache.org/repos/asf/cassandra/tree/6536c05b
Diff: http://git-wip-us.apache.org/repos/asf/cassandra/diff/6536c05b
Branch: refs/heads/trunk
Commit: 6536c05b48b08de9048f68967a5f69d17d56d6fd
Parents: bc6ea03
Author: Dave Brosius <db...@mebigfatguy.com>
Authored: Mon Dec 28 15:15:15 2015 -0500
Committer: Dave Brosius <db...@mebigfatguy.com>
Committed: Mon Dec 28 15:15:15 2015 -0500
----------------------------------------------------------------------
.../org/apache/cassandra/db/partitions/CachedPartition.java | 6 +++---
.../db/rows/LazilyInitializedUnfilteredRowIterator.java | 2 +-
.../org/apache/cassandra/db/rows/RangeTombstoneMarker.java | 3 ++-
src/java/org/apache/cassandra/db/rows/Unfiltered.java | 2 +-
src/java/org/apache/cassandra/index/Index.java | 2 +-
.../org/apache/cassandra/io/sstable/format/SSTableReader.java | 1 -
src/java/org/apache/cassandra/io/util/RandomAccessReader.java | 4 ++--
src/java/org/apache/cassandra/repair/Validator.java | 2 +-
src/java/org/apache/cassandra/schema/Indexes.java | 4 ++--
src/java/org/apache/cassandra/service/StorageServiceMBean.java | 2 +-
.../org/apache/cassandra/thrift/CustomTThreadPoolServer.java | 4 ++--
src/java/org/apache/cassandra/utils/ByteBufferUtil.java | 1 -
src/java/org/apache/cassandra/utils/CassandraVersion.java | 6 ++++--
13 files changed, 20 insertions(+), 19 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6536c05b/src/java/org/apache/cassandra/db/partitions/CachedPartition.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/partitions/CachedPartition.java b/src/java/org/apache/cassandra/db/partitions/CachedPartition.java
index 33e6ecc..0cbaba0 100644
--- a/src/java/org/apache/cassandra/db/partitions/CachedPartition.java
+++ b/src/java/org/apache/cassandra/db/partitions/CachedPartition.java
@@ -45,7 +45,7 @@ public interface CachedPartition extends Partition, IRowCacheEntry
/**
* The number of rows that were live at the time the partition was cached.
*
- * See {@link ColumnFamilyStore#isFilterFullyCoveredBy} to see why we need this.
+ * See {@link org.apache.cassandra.db.ColumnFamilyStore#isFilterFullyCoveredBy} to see why we need this.
*
* @return the number of rows in this partition that were live at the time the
* partition was cached (this can be different from the number of live rows now
@@ -58,7 +58,7 @@ public interface CachedPartition extends Partition, IRowCacheEntry
* non-deleted cell.
*
* Note that this is generally not a very meaningful number, but this is used by
- * {@link DataLimits#hasEnoughLiveData} as an optimization.
+ * {@link org.apache.cassandra.db.filter.DataLimits#hasEnoughLiveData} as an optimization.
*
* @return the number of row that have at least one non-expiring non-deleted cell.
*/
@@ -86,7 +86,7 @@ public interface CachedPartition extends Partition, IRowCacheEntry
* The number of cells in this cached partition that are neither tombstone nor expiring.
*
* Note that this is generally not a very meaningful number, but this is used by
- * {@link DataLimits#hasEnoughLiveData} as an optimization.
+ * {@link org.apache.cassandra.db.filter.DataLimits#hasEnoughLiveData} as an optimization.
*
* @return the number of cells that are neither tombstones nor expiring.
*/
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6536c05b/src/java/org/apache/cassandra/db/rows/LazilyInitializedUnfilteredRowIterator.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/rows/LazilyInitializedUnfilteredRowIterator.java b/src/java/org/apache/cassandra/db/rows/LazilyInitializedUnfilteredRowIterator.java
index 8ba4394..1bf78dd 100644
--- a/src/java/org/apache/cassandra/db/rows/LazilyInitializedUnfilteredRowIterator.java
+++ b/src/java/org/apache/cassandra/db/rows/LazilyInitializedUnfilteredRowIterator.java
@@ -27,7 +27,7 @@ import org.apache.cassandra.db.*;
*
* This is used during partition range queries when we know the partition key but want
* to defer the initialization of the rest of the UnfilteredRowIterator until we need those informations.
- * See {@link BigTableScanner#KeyScanningIterator} for instance.
+ * See {@link org.apache.cassandra.io.sstable.format.big.BigTableScanner#KeyScanningIterator} for instance.
*/
public abstract class LazilyInitializedUnfilteredRowIterator extends AbstractIterator<Unfiltered> implements UnfilteredRowIterator
{
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6536c05b/src/java/org/apache/cassandra/db/rows/RangeTombstoneMarker.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/rows/RangeTombstoneMarker.java b/src/java/org/apache/cassandra/db/rows/RangeTombstoneMarker.java
index 5771a86..053b5dc 100644
--- a/src/java/org/apache/cassandra/db/rows/RangeTombstoneMarker.java
+++ b/src/java/org/apache/cassandra/db/rows/RangeTombstoneMarker.java
@@ -27,7 +27,8 @@ import org.apache.cassandra.utils.memory.AbstractAllocator;
/**
* A marker for a range tombstone bound.
* <p>
- * There is 2 types of markers: bounds (see {@link RangeTombstoneBound}) and boundaries (see {@link RangeTombstoneBoundary}).
+ * There is 2 types of markers: bounds (see {@link RangeTombstoneBoundMarker}) and boundaries (see {@link RangeTombstoneBoundaryMarker}).
+ * </p>
*/
public interface RangeTombstoneMarker extends Unfiltered
{
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6536c05b/src/java/org/apache/cassandra/db/rows/Unfiltered.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/rows/Unfiltered.java b/src/java/org/apache/cassandra/db/rows/Unfiltered.java
index ba03741..d34403c 100644
--- a/src/java/org/apache/cassandra/db/rows/Unfiltered.java
+++ b/src/java/org/apache/cassandra/db/rows/Unfiltered.java
@@ -49,7 +49,7 @@ public interface Unfiltered extends Clusterable
* Validate the data of this atom.
*
* @param metadata the metadata for the table this atom is part of.
- * @throws MarshalException if some of the data in this atom is
+ * @throws org.apache.cassandra.serializers.MarshalException if some of the data in this atom is
* invalid (some value is invalid for its column type, or some field
* is nonsensical).
*/
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6536c05b/src/java/org/apache/cassandra/index/Index.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/index/Index.java b/src/java/org/apache/cassandra/index/Index.java
index 75429c7..3aadce9 100644
--- a/src/java/org/apache/cassandra/index/Index.java
+++ b/src/java/org/apache/cassandra/index/Index.java
@@ -491,7 +491,7 @@ public interface Index
public interface Searcher
{
/**
- * @param orderGroup the collection of OpOrder.Groups which the ReadCommand is being performed under.
+ * @param executionController the collection of OpOrder.Groups which the ReadCommand is being performed under.
* @return partitions from the base table matching the criteria of the search.
*/
public UnfilteredPartitionIterator search(ReadExecutionController executionController);
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6536c05b/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java b/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java
index 1dafea3..c63e52d 100644
--- a/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java
+++ b/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java
@@ -1664,7 +1664,6 @@ public abstract class SSTableReader extends SSTable implements SelfRefCounted<SS
* When calling this function, the caller must ensure that the SSTableReader is not referenced anywhere
* except for threads holding a reference.
*
- * @return true if the this is the first time the file was marked obsolete. Calling this
* multiple times is usually buggy (see exceptions in Tracker.unmarkCompacting and removeOldSSTablesSize).
*/
public void markObsolete(Runnable tidier)
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6536c05b/src/java/org/apache/cassandra/io/util/RandomAccessReader.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/io/util/RandomAccessReader.java b/src/java/org/apache/cassandra/io/util/RandomAccessReader.java
index b495bf0..e6da1a7 100644
--- a/src/java/org/apache/cassandra/io/util/RandomAccessReader.java
+++ b/src/java/org/apache/cassandra/io/util/RandomAccessReader.java
@@ -308,10 +308,10 @@ public class RandomAccessReader extends RebufferingInputStream implements FileDa
* represented by zero or more characters followed by {@code '\n'}, {@code
* '\r'}, {@code "\r\n"} or the end of file marker. The string does not
* include the line terminating sequence.
- * <p/>
+ * <p>
* Blocks until a line terminating sequence has been read, the end of the
* file is reached or an exception is thrown.
- *
+ * </p>
* @return the contents of the line or {@code null} if no characters have
* been read before the end of the file has been reached.
* @throws IOException if this file is closed or another I/O error occurs.
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6536c05b/src/java/org/apache/cassandra/repair/Validator.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/repair/Validator.java b/src/java/org/apache/cassandra/repair/Validator.java
index 3db9761..6308f6b 100644
--- a/src/java/org/apache/cassandra/repair/Validator.java
+++ b/src/java/org/apache/cassandra/repair/Validator.java
@@ -128,7 +128,7 @@ public class Validator implements Runnable
* Called (in order) for every row present in the CF.
* Hashes the row, and adds it to the tree being built.
*
- * @param row Row to add hash
+ * @param partition Partition to add hash
*/
public void add(UnfilteredRowIterator partition)
{
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6536c05b/src/java/org/apache/cassandra/schema/Indexes.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/schema/Indexes.java b/src/java/org/apache/cassandra/schema/Indexes.java
index 49a1d3b..eb49d39 100644
--- a/src/java/org/apache/cassandra/schema/Indexes.java
+++ b/src/java/org/apache/cassandra/schema/Indexes.java
@@ -95,7 +95,7 @@ public class Indexes implements Iterable<IndexMetadata>
/**
* Get the index with the specified id
*
- * @param name a UUID which identifies an index
+ * @param id a UUID which identifies an index
* @return an empty {@link Optional} if no index with the specified id is found; a non-empty optional of
* {@link IndexMetadata} otherwise
*/
@@ -107,7 +107,7 @@ public class Indexes implements Iterable<IndexMetadata>
/**
* Answer true if contains an index with the specified id.
- * @param name a UUID which identifies an index.
+ * @param id a UUID which identifies an index.
* @return true if an index with the specified id is found; false otherwise
*/
public boolean has(UUID id)
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6536c05b/src/java/org/apache/cassandra/service/StorageServiceMBean.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/service/StorageServiceMBean.java b/src/java/org/apache/cassandra/service/StorageServiceMBean.java
index 64e60fd..ae3889a 100644
--- a/src/java/org/apache/cassandra/service/StorageServiceMBean.java
+++ b/src/java/org/apache/cassandra/service/StorageServiceMBean.java
@@ -515,7 +515,7 @@ public interface StorageServiceMBean extends NotificationEmitter
* Load new SSTables to the given keyspace/table
*
* @param ksName The parent keyspace name
- * @param cfName The ColumnFamily name where SSTables belong
+ * @param tableName The ColumnFamily name where SSTables belong
*/
public void loadNewSSTables(String ksName, String tableName);
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6536c05b/src/java/org/apache/cassandra/thrift/CustomTThreadPoolServer.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/thrift/CustomTThreadPoolServer.java b/src/java/org/apache/cassandra/thrift/CustomTThreadPoolServer.java
index bde5310..87c6409 100644
--- a/src/java/org/apache/cassandra/thrift/CustomTThreadPoolServer.java
+++ b/src/java/org/apache/cassandra/thrift/CustomTThreadPoolServer.java
@@ -56,8 +56,8 @@ import com.google.common.util.concurrent.Uninterruptibles;
* Slightly modified version of the Apache Thrift TThreadPoolServer.
* <p>
* This allows passing an executor so you have more control over the actual
- * behaviour of the tasks being run.
- * <p/>
+ * behavior of the tasks being run.
+ * </p>
* Newer version of Thrift should make this obsolete.
*/
public class CustomTThreadPoolServer extends TServer
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6536c05b/src/java/org/apache/cassandra/utils/ByteBufferUtil.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/utils/ByteBufferUtil.java b/src/java/org/apache/cassandra/utils/ByteBufferUtil.java
index e1bc5c7..6bcec96 100644
--- a/src/java/org/apache/cassandra/utils/ByteBufferUtil.java
+++ b/src/java/org/apache/cassandra/utils/ByteBufferUtil.java
@@ -383,7 +383,6 @@ public class ByteBufferUtil
/**
* @param in data input
- * @return null
* @throws IOException if an I/O error occurs.
*/
public static void skipShortLength(DataInputPlus in) throws IOException
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6536c05b/src/java/org/apache/cassandra/utils/CassandraVersion.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/utils/CassandraVersion.java b/src/java/org/apache/cassandra/utils/CassandraVersion.java
index 62d68be..6887a88 100644
--- a/src/java/org/apache/cassandra/utils/CassandraVersion.java
+++ b/src/java/org/apache/cassandra/utils/CassandraVersion.java
@@ -26,8 +26,9 @@ import org.apache.commons.lang3.StringUtils;
/**
* Implements versioning used in Cassandra and CQL.
- * <p/>
+ * <p>
* Note: The following code uses a slight variation from the semver document (http://semver.org).
+ * </p>
*/
public class CassandraVersion implements Comparable<CassandraVersion>
{
@@ -123,13 +124,14 @@ public class CassandraVersion implements Comparable<CassandraVersion>
/**
* Returns a version that is backward compatible with this version amongst a list
* of provided version, or null if none can be found.
- * <p/>
+ * <p>
* For instance:
* "2.0.0".findSupportingVersion("2.0.0", "3.0.0") == "2.0.0"
* "2.0.0".findSupportingVersion("2.1.3", "3.0.0") == "2.1.3"
* "2.0.0".findSupportingVersion("3.0.0") == null
* "2.0.3".findSupportingVersion("2.0.0") == "2.0.0"
* "2.1.0".findSupportingVersion("2.0.0") == null
+ * </p>
*/
public CassandraVersion findSupportingVersion(CassandraVersion... versions)
{