You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by se...@apache.org on 2014/07/09 12:21:38 UTC
[11/12] git commit: Clean up checkstyle and JavaDoc errors in core
project
Clean up checkstyle and JavaDoc errors in core project
Project: http://git-wip-us.apache.org/repos/asf/incubator-flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-flink/commit/49ca3edd
Tree: http://git-wip-us.apache.org/repos/asf/incubator-flink/tree/49ca3edd
Diff: http://git-wip-us.apache.org/repos/asf/incubator-flink/diff/49ca3edd
Branch: refs/heads/master
Commit: 49ca3edd9508f09040c35dfad056debc1072a58b
Parents: 52f9cf6
Author: Stephan Ewen <se...@apache.org>
Authored: Wed Jul 9 03:20:30 2014 +0200
Committer: Stephan Ewen <se...@apache.org>
Committed: Wed Jul 9 03:20:30 2014 +0200
----------------------------------------------------------------------
.../api/common/operators/base/BulkIterationBase.java | 2 +-
.../eu/stratosphere/api/common/typeutils/TypeComparator.java | 4 ++--
.../src/main/java/eu/stratosphere/core/memory/DataInputView.java | 1 -
.../core/memory/InputViewDataInputStreamWrapper.java | 1 +
.../core/memory/InputViewObjectInputStreamWrapper.java | 1 +
.../java/eu/stratosphere/core/memory/SeekableDataInputView.java | 3 ---
.../src/main/java/eu/stratosphere/types/NormalizableKey.java | 4 ++--
.../src/main/java/eu/stratosphere/types/Record.java | 2 +-
.../src/test/java/eu/stratosphere/types/RecordTest.java | 2 --
9 files changed, 8 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/49ca3edd/stratosphere-core/src/main/java/eu/stratosphere/api/common/operators/base/BulkIterationBase.java
----------------------------------------------------------------------
diff --git a/stratosphere-core/src/main/java/eu/stratosphere/api/common/operators/base/BulkIterationBase.java b/stratosphere-core/src/main/java/eu/stratosphere/api/common/operators/base/BulkIterationBase.java
index 6de9959..af8003e 100644
--- a/stratosphere-core/src/main/java/eu/stratosphere/api/common/operators/base/BulkIterationBase.java
+++ b/stratosphere-core/src/main/java/eu/stratosphere/api/common/operators/base/BulkIterationBase.java
@@ -145,7 +145,7 @@ public class BulkIterationBase<T> extends SingleInputOperator<T, T, AbstractFunc
}
/**
- * @throws Exception
+ * @throws InvalidProgramException
*/
public void validate() throws InvalidProgramException {
if (this.input == null) {
http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/49ca3edd/stratosphere-core/src/main/java/eu/stratosphere/api/common/typeutils/TypeComparator.java
----------------------------------------------------------------------
diff --git a/stratosphere-core/src/main/java/eu/stratosphere/api/common/typeutils/TypeComparator.java b/stratosphere-core/src/main/java/eu/stratosphere/api/common/typeutils/TypeComparator.java
index e519d89..aec4239 100644
--- a/stratosphere-core/src/main/java/eu/stratosphere/api/common/typeutils/TypeComparator.java
+++ b/stratosphere-core/src/main/java/eu/stratosphere/api/common/typeutils/TypeComparator.java
@@ -40,7 +40,7 @@ import eu.stratosphere.core.memory.MemorySegment;
* @see java.lang.Object#equals(Object)
* @see java.util.Comparator#compare(Object, Object)
*
- * @param T The data type that the comparator works on.
+ * @param <T> The data type that the comparator works on.
*/
public abstract class TypeComparator<T> implements Serializable {
@@ -192,7 +192,7 @@ public abstract class TypeComparator<T> implements Serializable {
/**
* Gets the number of bytes that the normalized key would maximally take. A value of
- * {@link java.lang.Integer.MAX_VALUE} is interpreted as infinite.
+ * {@link java.lang.Integer}.MAX_VALUE is interpreted as infinite.
*
* @return The number of bytes that the normalized key would maximally take.
*/
http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/49ca3edd/stratosphere-core/src/main/java/eu/stratosphere/core/memory/DataInputView.java
----------------------------------------------------------------------
diff --git a/stratosphere-core/src/main/java/eu/stratosphere/core/memory/DataInputView.java b/stratosphere-core/src/main/java/eu/stratosphere/core/memory/DataInputView.java
index db9aa6d..4b85f74 100644
--- a/stratosphere-core/src/main/java/eu/stratosphere/core/memory/DataInputView.java
+++ b/stratosphere-core/src/main/java/eu/stratosphere/core/memory/DataInputView.java
@@ -30,7 +30,6 @@ public interface DataInputView extends DataInput {
*
* @param numBytes The number of bytes to skip.
*
- * @throws EOFException Thrown, when less then {@code numBytes} remain in the input.
* @throws IOException Thrown, if any I/O related problem occurred such that the input could not
* be advanced to the desired position.
*/
http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/49ca3edd/stratosphere-core/src/main/java/eu/stratosphere/core/memory/InputViewDataInputStreamWrapper.java
----------------------------------------------------------------------
diff --git a/stratosphere-core/src/main/java/eu/stratosphere/core/memory/InputViewDataInputStreamWrapper.java b/stratosphere-core/src/main/java/eu/stratosphere/core/memory/InputViewDataInputStreamWrapper.java
index 8344109..16569ab 100644
--- a/stratosphere-core/src/main/java/eu/stratosphere/core/memory/InputViewDataInputStreamWrapper.java
+++ b/stratosphere-core/src/main/java/eu/stratosphere/core/memory/InputViewDataInputStreamWrapper.java
@@ -108,6 +108,7 @@ public class InputViewDataInputStreamWrapper implements DataInputView {
return in.readDouble();
}
+ @SuppressWarnings("deprecation")
@Override
public String readLine() throws IOException {
return in.readLine();
http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/49ca3edd/stratosphere-core/src/main/java/eu/stratosphere/core/memory/InputViewObjectInputStreamWrapper.java
----------------------------------------------------------------------
diff --git a/stratosphere-core/src/main/java/eu/stratosphere/core/memory/InputViewObjectInputStreamWrapper.java b/stratosphere-core/src/main/java/eu/stratosphere/core/memory/InputViewObjectInputStreamWrapper.java
index 55c9d8f..52d62e0 100644
--- a/stratosphere-core/src/main/java/eu/stratosphere/core/memory/InputViewObjectInputStreamWrapper.java
+++ b/stratosphere-core/src/main/java/eu/stratosphere/core/memory/InputViewObjectInputStreamWrapper.java
@@ -108,6 +108,7 @@ public class InputViewObjectInputStreamWrapper implements DataInputView {
return in.readDouble();
}
+ @SuppressWarnings("deprecation")
@Override
public String readLine() throws IOException {
return in.readLine();
http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/49ca3edd/stratosphere-core/src/main/java/eu/stratosphere/core/memory/SeekableDataInputView.java
----------------------------------------------------------------------
diff --git a/stratosphere-core/src/main/java/eu/stratosphere/core/memory/SeekableDataInputView.java b/stratosphere-core/src/main/java/eu/stratosphere/core/memory/SeekableDataInputView.java
index eda486b..672d257 100644
--- a/stratosphere-core/src/main/java/eu/stratosphere/core/memory/SeekableDataInputView.java
+++ b/stratosphere-core/src/main/java/eu/stratosphere/core/memory/SeekableDataInputView.java
@@ -23,9 +23,6 @@ public interface SeekableDataInputView extends DataInputView {
* Sets the read pointer to the given position.
*
* @param position The new read position.
- *
- * @throws IOException Thrown, if any I/O related problem occurred such that the input could not
- * be sought to the desired position.
*/
public void setReadPosition(long position);
}
http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/49ca3edd/stratosphere-core/src/main/java/eu/stratosphere/types/NormalizableKey.java
----------------------------------------------------------------------
diff --git a/stratosphere-core/src/main/java/eu/stratosphere/types/NormalizableKey.java b/stratosphere-core/src/main/java/eu/stratosphere/types/NormalizableKey.java
index 2d20125..8aae4b6 100644
--- a/stratosphere-core/src/main/java/eu/stratosphere/types/NormalizableKey.java
+++ b/stratosphere-core/src/main/java/eu/stratosphere/types/NormalizableKey.java
@@ -32,11 +32,11 @@ public interface NormalizableKey<T> extends Key<T> {
/**
* Gets the maximal length of normalized keys that the data type would produce to determine
- * the order of instances solely by the normalized key. A value of {@link java.lang.Integer.MAX_VALUE}
+ * the order of instances solely by the normalized key. A value of {@link java.lang.Integer}.MAX_VALUE
* is interpreted as infinite.
* <p>
* For example, 32 bit integers return four, while Strings (potentially unlimited in length) return
- * {@link java.lang.Integer.MAX_VALUE}.
+ * {@link java.lang.Integer}.MAX_VALUE.
*
* @return The maximal length of normalized keys.
*/
http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/49ca3edd/stratosphere-core/src/main/java/eu/stratosphere/types/Record.java
----------------------------------------------------------------------
diff --git a/stratosphere-core/src/main/java/eu/stratosphere/types/Record.java b/stratosphere-core/src/main/java/eu/stratosphere/types/Record.java
index 78e90f0..d07f1f6 100644
--- a/stratosphere-core/src/main/java/eu/stratosphere/types/Record.java
+++ b/stratosphere-core/src/main/java/eu/stratosphere/types/Record.java
@@ -344,7 +344,7 @@ public final class Record implements Value, CopyableValue<Record> {
* @param positions The positions of the fields to get.
* @param targets The values into which the content of the fields is put.
*
- * @throws A NullKeyFieldException in case of a failing field read.
+ * @throws NullKeyFieldException in case of a failing field read.
*/
public void getFieldsIntoCheckingNull(int[] positions, Value[] targets) {
for (int i = 0; i < positions.length; i++) {
http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/49ca3edd/stratosphere-core/src/test/java/eu/stratosphere/types/RecordTest.java
----------------------------------------------------------------------
diff --git a/stratosphere-core/src/test/java/eu/stratosphere/types/RecordTest.java b/stratosphere-core/src/test/java/eu/stratosphere/types/RecordTest.java
index 89b3ce6..0118f10 100644
--- a/stratosphere-core/src/test/java/eu/stratosphere/types/RecordTest.java
+++ b/stratosphere-core/src/test/java/eu/stratosphere/types/RecordTest.java
@@ -16,9 +16,7 @@ package eu.stratosphere.types;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
-import java.io.DataInput;
import java.io.DataInputStream;
-import java.io.DataOutput;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.PipedInputStream;