Repository: cassandra Updated Branches: refs/heads/trunk 203efd022 -> f44110c7f
fix some JDK 8 javadoc lint errors Project: http://git-wip-us.apache.org/repos/asf/cassandra/repo Commit: http://git-wip-us.apache.org/repos/asf/cassandra/commit/f44110c7 Tree: http://git-wip-us.apache.org/repos/asf/cassandra/tree/f44110c7 Diff: http://git-wip-us.apache.org/repos/asf/cassandra/diff/f44110c7 Branch: refs/heads/trunk Commit: f44110c7fc2ab43fb4cb8d1ae3ac6aa52dcc8eea Parents: 203efd0 Author: Dave Brosius <[email protected]> Authored: Sat Nov 8 17:29:15 2014 -0500 Committer: Dave Brosius <[email protected]> Committed: Sat Nov 8 17:29:15 2014 -0500 ---------------------------------------------------------------------- src/java/org/apache/cassandra/gms/VersionedValue.java | 4 ++-- .../cassandra/hadoop/AbstractColumnFamilyOutputFormat.java | 2 -- .../org/apache/cassandra/hadoop/ColumnFamilyOutputFormat.java | 1 - src/java/org/apache/cassandra/io/IVersionedSerializer.java | 4 ++-- .../org/apache/cassandra/io/compress/CompressionMetadata.java | 2 ++ .../org/apache/cassandra/io/compress/CompressionParameters.java | 4 ++++ src/java/org/apache/cassandra/io/util/DataOutputBuffer.java | 4 +++- src/java/org/apache/cassandra/io/util/SequentialWriter.java | 4 +++- src/java/org/apache/cassandra/repair/RepairJob.java | 1 + src/java/org/apache/cassandra/repair/RepairSession.java | 3 +++ src/java/org/apache/cassandra/service/CassandraDaemon.java | 2 -- src/java/org/apache/cassandra/utils/memory/SlabAllocator.java | 4 ++-- 12 files changed, 22 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cassandra/blob/f44110c7/src/java/org/apache/cassandra/gms/VersionedValue.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/gms/VersionedValue.java b/src/java/org/apache/cassandra/gms/VersionedValue.java index 36c2f00..a779982 100644 --- a/src/java/org/apache/cassandra/gms/VersionedValue.java +++ b/src/java/org/apache/cassandra/gms/VersionedValue.java @@ -43,9 +43,9 @@ import org.apache.commons.lang3.StringUtils; * application wants to make available to the rest of the nodes in the cluster. * Whenever a piece of state needs to be disseminated to the rest of cluster wrap * the state in an instance of <i>ApplicationState</i> and add it to the Gossiper. - * <p/> + * <p></p> * e.g. if we want to disseminate load information for node A do the following: - * <p/> + * <p></p> * ApplicationState loadState = new ApplicationState(<string representation of load>); * Gossiper.instance.addApplicationState("LOAD STATE", loadState); */ http://git-wip-us.apache.org/repos/asf/cassandra/blob/f44110c7/src/java/org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.java b/src/java/org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.java index f4963fb..f574641 100644 --- a/src/java/org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.java +++ b/src/java/org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.java @@ -67,8 +67,6 @@ public abstract class AbstractColumnFamilyOutputFormat<K, Y> extends OutputForma * * @param context * information about the job - * @throws IOException - * when output should not be attempted */ public void checkOutputSpecs(JobContext context) { http://git-wip-us.apache.org/repos/asf/cassandra/blob/f44110c7/src/java/org/apache/cassandra/hadoop/ColumnFamilyOutputFormat.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/hadoop/ColumnFamilyOutputFormat.java b/src/java/org/apache/cassandra/hadoop/ColumnFamilyOutputFormat.java index 49aaf99..c5489c6 100644 --- a/src/java/org/apache/cassandra/hadoop/ColumnFamilyOutputFormat.java +++ b/src/java/org/apache/cassandra/hadoop/ColumnFamilyOutputFormat.java @@ -60,7 +60,6 @@ public class ColumnFamilyOutputFormat extends AbstractColumnFamilyOutputFormat<B * @param context * the information about the current task. * @return a {@link RecordWriter} to write the output for the job. - * @throws IOException */ public ColumnFamilyRecordWriter getRecordWriter(final TaskAttemptContext context) throws InterruptedException { http://git-wip-us.apache.org/repos/asf/cassandra/blob/f44110c7/src/java/org/apache/cassandra/io/IVersionedSerializer.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/io/IVersionedSerializer.java b/src/java/org/apache/cassandra/io/IVersionedSerializer.java index 46494e1..2572840 100644 --- a/src/java/org/apache/cassandra/io/IVersionedSerializer.java +++ b/src/java/org/apache/cassandra/io/IVersionedSerializer.java @@ -30,7 +30,7 @@ public interface IVersionedSerializer<T> * @param t type that needs to be serialized * @param out DataOutput into which serialization needs to happen. * @param version protocol version - * @throws java.io.IOException + * @throws java.io.IOException if serialization fails */ public void serialize(T t, DataOutputPlus out, int version) throws IOException; @@ -39,7 +39,7 @@ public interface IVersionedSerializer<T> * @param in DataInput from which deserialization needs to happen. * @param version protocol version * @return the type that was deserialized - * @throws IOException + * @throws IOException if deserialization fails */ public T deserialize(DataInput in, int version) throws IOException; http://git-wip-us.apache.org/repos/asf/cassandra/blob/f44110c7/src/java/org/apache/cassandra/io/compress/CompressionMetadata.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/io/compress/CompressionMetadata.java b/src/java/org/apache/cassandra/io/compress/CompressionMetadata.java index 7f7ab82..3576057 100644 --- a/src/java/org/apache/cassandra/io/compress/CompressionMetadata.java +++ b/src/java/org/apache/cassandra/io/compress/CompressionMetadata.java @@ -340,6 +340,8 @@ public class CompressionMetadata /** * Reset the writer so that the next chunk offset written will be the * one of {@code chunkIndex}. + * + * @param chunkIndex the next index to write */ public void resetAndTruncate(int chunkIndex) { http://git-wip-us.apache.org/repos/asf/cassandra/blob/f44110c7/src/java/org/apache/cassandra/io/compress/CompressionParameters.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/io/compress/CompressionParameters.java b/src/java/org/apache/cassandra/io/compress/CompressionParameters.java index d3436c0..d94fed4 100644 --- a/src/java/org/apache/cassandra/io/compress/CompressionParameters.java +++ b/src/java/org/apache/cassandra/io/compress/CompressionParameters.java @@ -225,6 +225,10 @@ public class CompressionParameters /** * Parse the chunk length (in KB) and returns it as bytes. + * + * @param chLengthKB the length of the chunk to parse + * @return the chunk length in bytes + * @throws ConfigurationException if the chunk size is too large */ public static Integer parseChunkLength(String chLengthKB) throws ConfigurationException { http://git-wip-us.apache.org/repos/asf/cassandra/blob/f44110c7/src/java/org/apache/cassandra/io/util/DataOutputBuffer.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/io/util/DataOutputBuffer.java b/src/java/org/apache/cassandra/io/util/DataOutputBuffer.java index 7577567..c2eb08a 100644 --- a/src/java/org/apache/cassandra/io/util/DataOutputBuffer.java +++ b/src/java/org/apache/cassandra/io/util/DataOutputBuffer.java @@ -74,6 +74,8 @@ public final class DataOutputBuffer extends DataOutputStreamPlus /** * Returns the current contents of the buffer. Data is only valid to * {@link #getLength()}. + * + * @return the buffer contents */ public byte[] getData() { @@ -93,7 +95,7 @@ public final class DataOutputBuffer extends DataOutputStreamPlus return ByteBuffer.wrap(out.buf, 0, out.count); } - /** Returns the length of the valid data currently in the buffer. */ + /** @return the length of the valid data currently in the buffer. */ public int getLength() { return ((FastByteArrayOutputStream) out).count; http://git-wip-us.apache.org/repos/asf/cassandra/blob/f44110c7/src/java/org/apache/cassandra/io/util/SequentialWriter.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/io/util/SequentialWriter.java b/src/java/org/apache/cassandra/io/util/SequentialWriter.java index 7a7eb63..aea97aa 100644 --- a/src/java/org/apache/cassandra/io/util/SequentialWriter.java +++ b/src/java/org/apache/cassandra/io/util/SequentialWriter.java @@ -322,11 +322,13 @@ public class SequentialWriter extends OutputStream implements WritableByteChanne } /** - * Return the current file pointer of the underlying on-disk file. + * Returns the current file pointer of the underlying on-disk file. * Note that since write works by buffering data, the value of this will increase by buffer * size and not every write to the writer will modify this value. * Furthermore, for compressed files, this value refers to compressed data, while the * writer getFilePointer() refers to uncompressedFile + * + * @return the current file pointer */ public long getOnDiskFilePointer() { http://git-wip-us.apache.org/repos/asf/cassandra/blob/f44110c7/src/java/org/apache/cassandra/repair/RepairJob.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/repair/RepairJob.java b/src/java/org/apache/cassandra/repair/RepairJob.java index b0d17ab..0b40d4a 100644 --- a/src/java/org/apache/cassandra/repair/RepairJob.java +++ b/src/java/org/apache/cassandra/repair/RepairJob.java @@ -50,6 +50,7 @@ public class RepairJob extends AbstractFuture<RepairResult> implements Runnable * @param session RepairSession that this RepairJob belongs * @param columnFamily name of the ColumnFamily to repair * @param isSequential when true, validation runs sequentially among replica + * @param repairedAt when the repair occurred (millis) * @param taskExecutor Executor to run various repair tasks */ public RepairJob(RepairSession session, http://git-wip-us.apache.org/repos/asf/cassandra/blob/f44110c7/src/java/org/apache/cassandra/repair/RepairSession.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/repair/RepairSession.java b/src/java/org/apache/cassandra/repair/RepairSession.java index 240a21c..c273c4e 100644 --- a/src/java/org/apache/cassandra/repair/RepairSession.java +++ b/src/java/org/apache/cassandra/repair/RepairSession.java @@ -106,10 +106,13 @@ public class RepairSession extends AbstractFuture<List<RepairResult>> implements /** * Create new repair session. * + * @param parentRepairSession the parent sessions id + * @param id this sessions id * @param range range to repair * @param keyspace name of keyspace * @param isSequential true if performing repair on snapshots sequentially * @param endpoints the data centers that should be part of the repair; null for all DCs + * @param repairedAt when the repair occurred (millis) * @param cfnames names of columnfamilies */ public RepairSession(UUID parentRepairSession, http://git-wip-us.apache.org/repos/asf/cassandra/blob/f44110c7/src/java/org/apache/cassandra/service/CassandraDaemon.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/service/CassandraDaemon.java b/src/java/org/apache/cassandra/service/CassandraDaemon.java index 35db450..e4d262a 100644 --- a/src/java/org/apache/cassandra/service/CassandraDaemon.java +++ b/src/java/org/apache/cassandra/service/CassandraDaemon.java @@ -91,8 +91,6 @@ public class CassandraDaemon * This is a hook for concrete daemons to initialize themselves suitably. * * Subclasses should override this to finish the job (listening on ports, etc.) - * - * @throws IOException */ protected void setup() { http://git-wip-us.apache.org/repos/asf/cassandra/blob/f44110c7/src/java/org/apache/cassandra/utils/memory/SlabAllocator.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/utils/memory/SlabAllocator.java b/src/java/org/apache/cassandra/utils/memory/SlabAllocator.java index 19334ee..8defd25 100644 --- a/src/java/org/apache/cassandra/utils/memory/SlabAllocator.java +++ b/src/java/org/apache/cassandra/utils/memory/SlabAllocator.java @@ -34,12 +34,12 @@ import sun.nio.ch.DirectBuffer; * The SlabAllocator is a bump-the-pointer allocator that allocates * large (2MB by default) regions and then doles them out to threads that request * slices into the array. - * <p/> + * <p></p> * The purpose of this class is to combat heap fragmentation in long lived * objects: by ensuring that all allocations with similar lifetimes * only to large regions of contiguous memory, we ensure that large blocks * get freed up at the same time. - * <p/> + * <p></p> * Otherwise, variable length byte arrays allocated end up * interleaved throughout the heap, and the old generation gets progressively * more fragmented until a stop-the-world compacting collection occurs.
