You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by dh...@apache.org on 2016/11/05 08:33:58 UTC
[2/3] incubator-beam git commit: Fix javadoc throughout Beam
Fix javadoc throughout Beam
Project: http://git-wip-us.apache.org/repos/asf/incubator-beam/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-beam/commit/717b431c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam/tree/717b431c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam/diff/717b431c
Branch: refs/heads/master
Commit: 717b431c1aeeeec4bad279944c2a1a406b3f08ee
Parents: aae65db
Author: Dan Halperin <dh...@google.com>
Authored: Fri Nov 4 18:28:53 2016 -0700
Committer: Dan Halperin <dh...@google.com>
Committed: Sat Nov 5 01:30:40 2016 -0700
----------------------------------------------------------------------
.../beam/examples/complete/game/GameStats.java | 3 +-
.../examples/complete/game/LeaderBoard.java | 2 +-
.../beam/examples/complete/game/UserScore.java | 2 +-
.../flink/examples/streaming/AutoComplete.java | 8 ++---
.../flink/examples/streaming/JoinExamples.java | 12 +++----
.../examples/streaming/KafkaIOExamples.java | 2 +-
.../examples/streaming/WindowedWordCount.java | 8 ++---
.../runners/dataflow/DataflowPipelineJob.java | 1 -
.../runners/dataflow/internal/IsmFormat.java | 5 +--
.../runners/dataflow/util/MonitoringUtil.java | 1 -
.../runners/dataflow/util/RandomAccessData.java | 2 +-
.../java/org/apache/beam/sdk/io/AvroIO.java | 4 +--
.../org/apache/beam/sdk/io/BoundedSource.java | 11 +++---
.../apache/beam/sdk/io/CompressedSource.java | 2 --
.../org/apache/beam/sdk/io/FileBasedSink.java | 9 ++---
.../java/org/apache/beam/sdk/io/XmlSource.java | 2 +-
.../apache/beam/sdk/io/range/ByteKeyRange.java | 2 +-
.../apache/beam/sdk/options/ValueProvider.java | 2 +-
.../apache/beam/sdk/transforms/Aggregator.java | 12 +++----
.../apache/beam/sdk/transforms/CombineFns.java | 4 +--
.../org/apache/beam/sdk/transforms/DoFn.java | 22 ++++++------
.../org/apache/beam/sdk/transforms/ParDo.java | 2 +-
.../org/apache/beam/sdk/transforms/View.java | 2 +-
.../sdk/transforms/display/DisplayData.java | 5 ++-
.../beam/sdk/transforms/join/CoGroupByKey.java | 6 ++--
.../sdk/transforms/reflect/DoFnSignature.java | 2 +-
.../splittabledofn/RestrictionTracker.java | 2 +-
.../transforms/splittabledofn/package-info.java | 4 +--
.../beam/sdk/util/BaseExecutionContext.java | 2 +-
.../BufferedElementCountingOutputStream.java | 4 +--
.../apache/beam/sdk/util/ExecutionContext.java | 8 ++---
.../sdk/util/ExposedByteArrayInputStream.java | 5 +--
.../sdk/util/ExposedByteArrayOutputStream.java | 2 --
.../java/org/apache/beam/sdk/util/GcsUtil.java | 2 --
.../apache/beam/sdk/util/MovingFunction.java | 4 +--
.../org/apache/beam/sdk/util/PubsubClient.java | 32 +++---------------
.../org/apache/beam/sdk/util/StringUtils.java | 8 ++---
.../apache/beam/sdk/util/TimerInternals.java | 8 +++--
.../beam/sdk/util/state/StateNamespace.java | 16 ++++-----
.../java/org/apache/beam/sdk/values/PDone.java | 2 +-
.../beam/sdk/io/gcp/datastore/DatastoreV1.java | 2 +-
.../apache/beam/sdk/io/kinesis/KinesisIO.java | 35 +++++++++-----------
42 files changed, 109 insertions(+), 160 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/examples/java8/src/main/java/org/apache/beam/examples/complete/game/GameStats.java
----------------------------------------------------------------------
diff --git a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/GameStats.java b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/GameStats.java
index 5ebf892..2b5255f 100644
--- a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/GameStats.java
+++ b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/GameStats.java
@@ -100,7 +100,8 @@ public class GameStats extends LeaderBoard {
/**
* Filter out all but those users with a high clickrate, which we will consider as 'spammy' uesrs.
* We do this by finding the mean total score per user, then using that information as a side
- * input to filter out all but those user scores that are > (mean * SCORE_WEIGHT)
+ * input to filter out all but those user scores that are larger than
+ * {@code (mean * SCORE_WEIGHT)}.
*/
// [START DocInclude_AbuseDetect]
public static class CalculateSpammyUsers
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/examples/java8/src/main/java/org/apache/beam/examples/complete/game/LeaderBoard.java
----------------------------------------------------------------------
diff --git a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/LeaderBoard.java b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/LeaderBoard.java
index d5e3345..0a3dfb3 100644
--- a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/LeaderBoard.java
+++ b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/LeaderBoard.java
@@ -73,7 +73,7 @@ import org.joda.time.format.DateTimeFormatter;
* results, e.g. for 'team prizes'. We're now outputting window results as they're
* calculated, giving us much lower latency than with the previous batch examples.
*
- * <p>Run {@link injector.Injector} to generate pubsub data for this pipeline. The Injector
+ * <p>Run {@code injector.Injector} to generate pubsub data for this pipeline. The Injector
* documentation provides more detail on how to do this.
*
* <p>To execute this pipeline using the Dataflow service, specify the pipeline configuration
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/examples/java8/src/main/java/org/apache/beam/examples/complete/game/UserScore.java
----------------------------------------------------------------------
diff --git a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/UserScore.java b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/UserScore.java
index 32c939f..f4dca32 100644
--- a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/UserScore.java
+++ b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/UserScore.java
@@ -68,7 +68,7 @@ import org.slf4j.LoggerFactory;
* where the BigQuery dataset you specify must already exist.
*
* <p>Optionally include the --input argument to specify a batch input file.
- * See the --input default value for example batch data file, or use {@link injector.Injector} to
+ * See the --input default value for example batch data file, or use {@code injector.Injector} to
* generate your own batch data.
*/
public class UserScore {
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/AutoComplete.java
----------------------------------------------------------------------
diff --git a/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/AutoComplete.java b/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/AutoComplete.java
index 97ba232..1e0c3ac 100644
--- a/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/AutoComplete.java
+++ b/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/AutoComplete.java
@@ -53,11 +53,9 @@ import org.joda.time.Duration;
/**
* To run the example, first open a socket on a terminal by executing the command:
- * <li>
- * <li>
- * <code>nc -lk 9999</code>
- * </li>
- * </li>
+ * <ul>
+ * <li><code>nc -lk 9999</code>
+ * </ul>
* and then launch the example. Now whatever you type in the terminal is going to be
* the input to the program.
* */
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/JoinExamples.java
----------------------------------------------------------------------
diff --git a/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/JoinExamples.java b/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/JoinExamples.java
index 96638aa..8fefc9f 100644
--- a/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/JoinExamples.java
+++ b/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/JoinExamples.java
@@ -39,14 +39,10 @@ import org.joda.time.Duration;
/**
* To run the example, first open two sockets on two terminals by executing the commands:
- * <li>
- * <li>
- * <code>nc -lk 9999</code>, and
- * </li>
- * <li>
- * <code>nc -lk 9998</code>
- * </li>
- * </li>
+ * <ul>
+ * <li><code>nc -lk 9999</code>, and
+ * <li><code>nc -lk 9998</code>
+ * </ul>
* and then launch the example. Now whatever you type in the terminal is going to be
* the input to the program.
* */
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/KafkaIOExamples.java
----------------------------------------------------------------------
diff --git a/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/KafkaIOExamples.java b/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/KafkaIOExamples.java
index f0bf188..3c8a89b 100644
--- a/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/KafkaIOExamples.java
+++ b/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/KafkaIOExamples.java
@@ -170,7 +170,7 @@ public class KafkaIOExamples {
/**
* Serialiation/Deserialiation schema for Avro types.
- * @param <T>
+ * @param <T> the type being encoded
*/
static class AvroSerializationDeserializationSchema<T>
implements SerializationSchema<T>, DeserializationSchema<T> {
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/WindowedWordCount.java
----------------------------------------------------------------------
diff --git a/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/WindowedWordCount.java b/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/WindowedWordCount.java
index 0e250b8..2246bdd 100644
--- a/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/WindowedWordCount.java
+++ b/runners/flink/examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/WindowedWordCount.java
@@ -42,11 +42,9 @@ import org.slf4j.LoggerFactory;
/**
* To run the example, first open a socket on a terminal by executing the command:
- * <li>
- * <li>
- * <code>nc -lk 9999</code>
- * </li>
- * </li>
+ * <ul>
+ * <li><code>nc -lk 9999</code>
+ * </ul>
* and then launch the example. Now whatever you type in the terminal is going to be
* the input to the program.
* */
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/DataflowPipelineJob.java
----------------------------------------------------------------------
diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/DataflowPipelineJob.java b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/DataflowPipelineJob.java
index 27006a4..a2b632f 100644
--- a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/DataflowPipelineJob.java
+++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/DataflowPipelineJob.java
@@ -199,7 +199,6 @@ public class DataflowPipelineJob implements PipelineResult {
* thread is interrupted.
* @throws IOException If there is a persistent problem getting job
* information.
- * @throws InterruptedException
*/
@Nullable
@VisibleForTesting
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/internal/IsmFormat.java
----------------------------------------------------------------------
diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/internal/IsmFormat.java b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/internal/IsmFormat.java
index 903e7b4..2f83ffd 100644
--- a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/internal/IsmFormat.java
+++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/internal/IsmFormat.java
@@ -167,11 +167,12 @@ public class IsmFormat {
}
}
- /** A {@link Coder} for {@link IsmRecord}s.
+ /**
+ * A {@link Coder} for {@link IsmRecord}s.
*
* <p>Note that this coder standalone will not produce an Ism file. This coder can be used
* to materialize a {@link PCollection} of {@link IsmRecord}s. Only when this coder
- * is combined with an {@link IsmSink} will one produce an Ism file.
+ * is combined with an {@code IsmSink} will one produce an Ism file.
*
* <p>The {@link IsmRecord} encoded format is:
* <ul>
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/MonitoringUtil.java
----------------------------------------------------------------------
diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/MonitoringUtil.java b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/MonitoringUtil.java
index a6afccd..efb6d2b 100644
--- a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/MonitoringUtil.java
+++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/MonitoringUtil.java
@@ -149,7 +149,6 @@ public final class MonitoringUtil {
* @param startTimestampMs Return only those messages with a
* timestamp greater than this value.
* @return collection of messages
- * @throws IOException
*/
public ArrayList<JobMessage> getJobMessages(
String jobId, long startTimestampMs) throws IOException {
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/RandomAccessData.java
----------------------------------------------------------------------
diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/RandomAccessData.java b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/RandomAccessData.java
index 84c53ea..11eec19 100644
--- a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/RandomAccessData.java
+++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/RandomAccessData.java
@@ -121,7 +121,7 @@ public class RandomAccessData {
* A {@link Comparator} that compares two byte arrays lexicographically. It compares
* values as a list of unsigned bytes. The first pair of values that follow any common prefix,
* or when one array is a prefix of the other, treats the shorter array as the lesser.
- * For example, [] < [0x01] < [0x01, 0x7F] < [0x01, 0x80] < [0x02] < POSITIVE INFINITY.
+ * For example, {@code [] < [0x01] < [0x01, 0x7F] < [0x01, 0x80] < [0x02] < POSITIVE INFINITY}.
*
* <p>Note that a token type of positive infinity is supported and is greater than
* all other {@link RandomAccessData}.
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/io/AvroIO.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/AvroIO.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/AvroIO.java
index 6deca7f..bd0c655 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/AvroIO.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/AvroIO.java
@@ -117,10 +117,10 @@ import org.apache.beam.sdk.values.PDone;
* } </pre>
*
* <p>By default, {@link AvroIO.Write} produces output files that are compressed using the
- * {@link org.apache.avro.file.DeflateCodec CodecFactory.deflateCodec(6)}. This default can
+ * {@link org.apache.avro.file.Codec CodecFactory.deflateCodec(6)}. This default can
* be changed or overridden using {@link AvroIO.Write#withCodec}.
*
- * <p><h3>Permissions</h3>
+ * <h3>Permissions</h3>
* Permission requirements depend on the {@link PipelineRunner} that is used to execute the
* Dataflow job. Please refer to the documentation of corresponding {@link PipelineRunner}s for
* more details.
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/io/BoundedSource.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/BoundedSource.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/BoundedSource.java
index cd4d7db..b3dd138 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/BoundedSource.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/BoundedSource.java
@@ -50,9 +50,6 @@ import org.joda.time.Instant;
* </li>
* </ul>
*
- * <p>To use this class for supporting your custom input type, derive your class
- * class from it, and override the abstract methods. For an example, see {@link DatastoreIO}.
- *
* @param <T> Type of records read by the source.
*/
public abstract class BoundedSource<T> extends Source<T> {
@@ -135,7 +132,7 @@ public abstract class BoundedSource<T> extends Source<T> {
*
* <p>By default, returns null to indicate that this cannot be estimated.
*
- * <h5>Thread safety</h5>
+ * <h3>Thread safety</h3>
* If {@link #splitAtFraction} is implemented, this method can be called concurrently to other
* methods (including itself), and it is therefore critical for it to be implemented
* in a thread-safe way.
@@ -345,7 +342,7 @@ public abstract class BoundedSource<T> extends Source<T> {
*
* <p>Returns a {@code BoundedSource} representing the remainder.
*
- * <h5>Detailed description</h5>
+ * <h3>Detailed description</h3>
* Assuming the following sequence of calls:
* <pre>{@code
* BoundedSource<T> initial = reader.getCurrentSource();
@@ -371,11 +368,11 @@ public abstract class BoundedSource<T> extends Source<T> {
* corresponding to the given fraction. In this case, the method MUST have no effect
* (the reader must behave as if the method hadn't been called at all).
*
- * <h5>Statefulness</h5>
+ * <h3>Statefulness</h3>
* Since this method (if successful) affects the reader's source, in subsequent invocations
* "fraction" should be interpreted relative to the new current source.
*
- * <h5>Thread safety and blocking</h5>
+ * <h3>Thread safety and blocking</h3>
* This method will be called concurrently to other methods (however there will not be multiple
* concurrent invocations of this method itself), and it is critical for it to be implemented
* in a thread-safe way (otherwise data loss is possible).
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/io/CompressedSource.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/CompressedSource.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/CompressedSource.java
index f33b9bd..af0c8130 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/CompressedSource.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/CompressedSource.java
@@ -74,7 +74,6 @@ public class CompressedSource<T> extends FileBasedSource<T> {
public interface DecompressingChannelFactory extends Serializable {
/**
* Given a channel, create a channel that decompresses the content read from the channel.
- * @throws IOException
*/
ReadableByteChannel createDecompressingChannel(ReadableByteChannel channel)
throws IOException;
@@ -88,7 +87,6 @@ public class CompressedSource<T> extends FileBasedSource<T> {
extends DecompressingChannelFactory {
/**
* Given a channel, create a channel that decompresses the content read from the channel.
- * @throws IOException
*/
ReadableByteChannel createDecompressingChannel(String fileName, ReadableByteChannel channel)
throws IOException;
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/io/FileBasedSink.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/FileBasedSink.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/FileBasedSink.java
index 3d0fe04..101ff61 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/FileBasedSink.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/FileBasedSink.java
@@ -133,7 +133,8 @@ public abstract class FileBasedSink<T> extends Sink<T> {
/**
* The {@link WritableByteChannelFactory} that is used to wrap the raw data output to the
- * underlying channel. The default is to not compress the output using {@link #UNCOMPRESSED}.
+ * underlying channel. The default is to not compress the output using
+ * {@link CompressionType#UNCOMPRESSED}.
*/
protected final WritableByteChannelFactory writableByteChannelFactory;
@@ -206,11 +207,6 @@ public abstract class FileBasedSink<T> extends Sink<T> {
return baseOutputFilename;
}
- /**
- * Perform pipeline-construction-time validation. The default implementation is a no-op.
- * Subclasses should override to ensure the sink is valid and can be written to. It is recommended
- * to use {@link Preconditions#checkState(boolean)} in the implementation of this method.
- */
@Override
public void validate(PipelineOptions options) {}
@@ -802,7 +798,6 @@ public abstract class FileBasedSink<T> extends Sink<T> {
/**
* @param channel the {@link WritableByteChannel} to wrap
* @return the {@link WritableByteChannel} to be used during output
- * @throws IOException
*/
WritableByteChannel create(WritableByteChannel channel) throws IOException;
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/io/XmlSource.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/XmlSource.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/XmlSource.java
index aaee75a..1458f74 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/XmlSource.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/XmlSource.java
@@ -108,7 +108,7 @@ import org.codehaus.stax2.XMLInputFactory2;
* <p>These dependencies have been declared as optional in the sdks/java/core/pom.xml file of
* Apache Beam.
*
- * <p><h3>Permissions</h3>
+ * <h3>Permissions</h3>
* Permission requirements depend on the
* {@link org.apache.beam.sdk.runners.PipelineRunner PipelineRunner} that is
* used to execute the Beam pipeline. Please refer to the documentation of corresponding
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/io/range/ByteKeyRange.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/range/ByteKeyRange.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/range/ByteKeyRange.java
index 3063441..e30f8af 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/range/ByteKeyRange.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/range/ByteKeyRange.java
@@ -133,7 +133,7 @@ public final class ByteKeyRange implements Serializable {
* Specifically, if this range is unsplittable (e.g., because the start and end keys are equal
* up to padding by zero bytes), the list returned will only contain the start and end key.
*
- * @throws IllegalArgumentException if the specified number of splits is < 1
+ * @throws IllegalArgumentException if the specified number of splits is less than 1
* @see ByteKeyRange the ByteKeyRange class Javadoc for more information about split semantics.
*/
public List<ByteKey> split(int numSplits) {
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/options/ValueProvider.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/options/ValueProvider.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/options/ValueProvider.java
index 4f0280b..188b371 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/options/ValueProvider.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/options/ValueProvider.java
@@ -133,7 +133,7 @@ public interface ValueProvider<T> {
* construction time.
*
* <p>To enforce this contract, if there is no default, users must only call
- * {@link #get()} at execution time (after a call to {@link Pipeline#run}),
+ * {@link #get()} at execution time (after a call to {@link org.apache.beam.sdk.Pipeline#run}),
* which will provide the value of {@code optionsMap}.
*/
class RuntimeValueProvider<T> implements ValueProvider<T>, Serializable {
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/Aggregator.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/Aggregator.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/Aggregator.java
index 427ecfc..43f53a8 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/Aggregator.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/Aggregator.java
@@ -29,13 +29,11 @@ import org.apache.beam.sdk.util.ExecutionContext;
* typically from the {@link DoFn} constructor. Elements can be added to the
* {@code Aggregator} by calling {@link Aggregator#addValue}.
*
- * <p>Aggregators are visible in the monitoring UI, when the pipeline is run using
- * {@link DataflowRunner} along with their current value.
- * Aggregators may not become visible until the system begins executing the ParDo transform
- * that created them and/or their initial value is changed.
+ * <p>It is runner-dependent whether aggregators are accessible during pipeline execution or only
+ * after jobs have completed.
*
* <p>Example:
- * <pre> {@code
+ * <pre>{@code
* class MyDoFn extends DoFn<String, String> {
* private Aggregator<Integer, Integer> myAggregator;
*
@@ -43,12 +41,12 @@ import org.apache.beam.sdk.util.ExecutionContext;
* myAggregator = createAggregator("myAggregator", new Sum.SumIntegerFn());
* }
*
- * @ProcessElement
+ * {@literal @}ProcessElement
* public void processElement(ProcessContext c) {
* myAggregator.addValue(1);
* }
* }
- * } </pre>
+ * }</pre>
*
* @param <InputT> the type of input values
* @param <OutputT> the type of output values
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/CombineFns.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/CombineFns.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/CombineFns.java
index 1b3e525..e4e1c50 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/CombineFns.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/CombineFns.java
@@ -106,7 +106,7 @@ public class CombineFns {
* <p>The same {@link TupleTag} cannot be used in a composition multiple times.
*
* <p>Example:
- * <pre><{@code
+ * <pre>{@code
* PCollection<Integer> globalLatencies = ...;
*
* TupleTag<Integer> maxLatencyTag = new TupleTag<Integer>();
@@ -114,7 +114,7 @@ public class CombineFns {
*
* SimpleFunction<Integer, Integer> identityFn =
* new SimpleFunction<Integer, Integer>() {
- * @Override
+ * {@literal @}Override
* public Integer apply(Integer input) {
* return input;
* }};
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java
index 018877f..2b3962e 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java
@@ -76,15 +76,15 @@ import org.joda.time.Instant;
*
* <p>Example usage:
*
- * <pre> {@code
+ * <pre>{@code
* PCollection<String> lines = ... ;
* PCollection<String> words =
* lines.apply(ParDo.of(new DoFn<String, String>() {
- * @ProcessElement
+ * {@literal @}ProcessElement
* public void processElement(ProcessContext c, BoundedWindow window) {
*
* }}));
- * } </pre>
+ * }</pre>
*
* @param <InputT> the type of the (main) input elements
* @param <OutputT> the type of the (main) output elements
@@ -436,14 +436,14 @@ public abstract class DoFn<InputT, OutputT> implements Serializable, HasDisplayD
*
* <pre>{@code
* new DoFn<KV<Key, Foo>, Baz>() {
- * @StateId("my-state-id")
+ * {@literal @}StateId("my-state-id")
* private final StateSpec<K, ValueState<MyState>> myStateSpec =
* StateSpecs.value(new MyStateCoder());
*
- * @ProcessElement
+ * {@literal @}ProcessElement
* public void processElement(
* ProcessContext c,
- * @StateId("my-state-id") ValueState<MyState> myState) {
+ * {@literal @}StateId("my-state-id") ValueState<MyState> myState) {
* myState.read();
* myState.write(...);
* }
@@ -480,17 +480,17 @@ public abstract class DoFn<InputT, OutputT> implements Serializable, HasDisplayD
*
* <pre>{@code
* new DoFn<KV<Key, Foo>, Baz>() {
- * @TimerId("my-timer-id")
+ * {@literal @}TimerId("my-timer-id")
* private final TimerSpec myTimer = TimerSpecs.timerForDomain(TimeDomain.EVENT_TIME);
*
- * @ProcessElement
+ * {@literal @}ProcessElement
* public void processElement(
* ProcessContext c,
- * @TimerId("my-timer-id") Timer myTimer) {
+ * {@literal @}TimerId("my-timer-id") Timer myTimer) {
* myTimer.setForNowPlus(Duration.standardSeconds(...));
* }
*
- * @OnTimer("my-timer-id")
+ * {@literal @}OnTimer("my-timer-id")
* public void onMyTimer() {
* ...
* }
@@ -578,7 +578,7 @@ public abstract class DoFn<InputT, OutputT> implements Serializable, HasDisplayD
* <ul>
* <li>Its first argument must be a {@link DoFn.ProcessContext}.
* <li>If one of its arguments is a subtype of {@link RestrictionTracker}, then it is a <a
- * href="https://s.apache.org/splittable-do-fn>splittable</a> {@link DoFn} subject to the
+ * href="https://s.apache.org/splittable-do-fn">splittable</a> {@link DoFn} subject to the
* separate requirements described below. Items below are assuming this is not a splittable
* {@link DoFn}.
* <li>If one of its arguments is {@link BoundedWindow}, this argument corresponds to the window
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/ParDo.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/ParDo.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/ParDo.java
index a3a306a..0684a5c 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/ParDo.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/ParDo.java
@@ -96,7 +96,7 @@ import org.apache.beam.sdk.values.TypedPValue;
*
* <p>For example:
*
- * <pre><{@code
+ * <pre>{@code
* PCollection<String> lines = ...;
* PCollection<String> words =
* lines.apply(ParDo.of(new DoFn<String, String>() {
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/View.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/View.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/View.java
index d750efc..5fafc0a 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/View.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/View.java
@@ -213,7 +213,7 @@ public class View {
/**
* Returns a {@link View.AsMultimap} transform that takes a
- * {@link PCollection PCollection<KV<K, V>>}
+ * {@link PCollection PCollection<KV<K, V>>}
* as input and produces a {@link PCollectionView} mapping
* each window to its contents as a {@link Map Map<K, Iterable<V>>}
* for use as a side input.
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/DisplayData.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/DisplayData.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/DisplayData.java
index 46cf94a..1a2de97 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/DisplayData.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/DisplayData.java
@@ -87,9 +87,8 @@ public class DisplayData implements Serializable {
*
* <p>Use this method if the type of metadata is not known at compile time. For example:
*
- * <pre>
- * {@code
- * @Override
+ * <pre>{@code
+ * {@literal @}Override
* public void populateDisplayData(DisplayData.Builder builder) {
* Optional<DisplayData.Type> type = DisplayData.inferType(foo);
* if (type.isPresent()) {
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/join/CoGroupByKey.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/join/CoGroupByKey.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/join/CoGroupByKey.java
index 9546b29..b760e2c 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/join/CoGroupByKey.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/join/CoGroupByKey.java
@@ -43,7 +43,7 @@ import org.apache.beam.sdk.values.PCollectionList;
* <p>Example of performing a {@link CoGroupByKey} followed by a
* {@link ParDo} that consumes
* the results:
- * <pre> {@code
+ * <pre>{@code
* PCollection<KV<K, V1>> pt1 = ...;
* PCollection<KV<K, V2>> pt2 = ...;
*
@@ -57,7 +57,7 @@ import org.apache.beam.sdk.values.PCollectionList;
* PCollection<T> finalResultCollection =
* coGbkResultCollection.apply(ParDo.of(
* new DoFn<KV<K, CoGbkResult>, T>() {
- * @Override
+ * {@literal @}ProcessElement
* public void processElement(ProcessContext c) {
* KV<K, CoGbkResult> e = c.element();
* Iterable<V1> pt1Vals = e.getValue().getAll(t1);
@@ -66,7 +66,7 @@ import org.apache.beam.sdk.values.PCollectionList;
* c.output(...some T...);
* }
* }));
- * } </pre>
+ * }</pre>
*
* @param <K> the type of the keys in the input and output
* {@code PCollection}s
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/reflect/DoFnSignature.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/reflect/DoFnSignature.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/reflect/DoFnSignature.java
index 7087efa..11f6aa7 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/reflect/DoFnSignature.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/reflect/DoFnSignature.java
@@ -415,7 +415,7 @@ public abstract class DoFnSignature {
/**
* Describes a timer declaration; a field of type {@link TimerSpec} annotated with
- * {@DoFn.TimerId}.
+ * {@link DoFn.TimerId}.
*/
@AutoValue
public abstract static class TimerDeclaration {
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.java
index 6b249ee..268766b 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.java
@@ -21,7 +21,7 @@ import org.apache.beam.sdk.transforms.DoFn;
/**
* Manages concurrent access to the restriction and keeps track of its claimed part for a <a
- * href="https://s.apache.org/splittable-do-fn>splittable</a> {@link DoFn}.
+ * href="https://s.apache.org/splittable-do-fn">splittable</a> {@link DoFn}.
*/
public interface RestrictionTracker<RestrictionT> {
/**
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/splittabledofn/package-info.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/splittabledofn/package-info.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/splittabledofn/package-info.java
index 1ceb880..4523032 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/splittabledofn/package-info.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/splittabledofn/package-info.java
@@ -16,7 +16,7 @@
* limitations under the License.
*/
/**
- * Defines utilities related to <a href="https://s.apache.org/splittable-do-fn>splittable</a>
- * {@link org.apache.beam.sdk.transforms.DoFn}'s.
+ * Defines utilities related to <a href="https://s.apache.org/splittable-do-fn">splittable</a>
+ * {@link org.apache.beam.sdk.transforms.DoFn}.
*/
package org.apache.beam.sdk.transforms.splittabledofn;
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BaseExecutionContext.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BaseExecutionContext.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BaseExecutionContext.java
index 45bbe75..e26f2b0 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BaseExecutionContext.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BaseExecutionContext.java
@@ -38,7 +38,7 @@ import org.apache.beam.sdk.values.TupleTag;
* of {@link StepContext} from {@link #getOrCreateStepContext(String, String)} and
* {@link #getAllStepContexts()} without forcing each subclass to override the method, e.g.
* <pre>{@code
- * @Override
+ * {@literal @}Override
* StreamingModeExecutionContext.StepContext getOrCreateStepContext(...) {
* return (StreamingModeExecutionContext.StepContext) super.getOrCreateStepContext(...);
* }
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BufferedElementCountingOutputStream.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BufferedElementCountingOutputStream.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BufferedElementCountingOutputStream.java
index c17d92d..b0784ca 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BufferedElementCountingOutputStream.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BufferedElementCountingOutputStream.java
@@ -49,7 +49,7 @@ import org.apache.beam.sdk.coders.Coder.Context;
* </pre>
*
* <p>To read this stream:
- * <pre><code>
+ * <pre>{@code
* InputStream is = ...
* long count;
* do {
@@ -58,7 +58,7 @@ import org.apache.beam.sdk.coders.Coder.Context;
* // read an element from is
* }
* } while(count > 0);
- * </code></pre>
+ * }</pre>
*
* <p>The counts are encoded as variable length longs. See {@link VarInt#encode(long, OutputStream)}
* for more details. The end of the iterable is detected by reading a count of 0.
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExecutionContext.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExecutionContext.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExecutionContext.java
index 82d900c..f2a79bd 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExecutionContext.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExecutionContext.java
@@ -41,14 +41,14 @@ public interface ExecutionContext {
/**
* Hook for subclasses to implement that will be called whenever
- * {@link OldDoFn.Context#output}
+ * {@link org.apache.beam.sdk.transforms.OldDoFn.Context#output}
* is called.
*/
void noteOutput(WindowedValue<?> output);
/**
* Hook for subclasses to implement that will be called whenever
- * {@link OldDoFn.Context#sideOutput}
+ * {@link org.apache.beam.sdk.transforms.OldDoFn.Context#sideOutput}
* is called.
*/
void noteSideOutput(TupleTag<?> tag, WindowedValue<?> output);
@@ -70,14 +70,14 @@ public interface ExecutionContext {
/**
* Hook for subclasses to implement that will be called whenever
- * {@link OldDoFn.Context#output}
+ * {@link org.apache.beam.sdk.transforms.OldDoFn.Context#output}
* is called.
*/
void noteOutput(WindowedValue<?> output);
/**
* Hook for subclasses to implement that will be called whenever
- * {@link OldDoFn.Context#sideOutput}
+ * {@link org.apache.beam.sdk.transforms.OldDoFn.Context#sideOutput}
* is called.
*/
void noteSideOutput(TupleTag<?> tag, WindowedValue<?> output);
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayInputStream.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayInputStream.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayInputStream.java
index 020c453..662ea38 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayInputStream.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayInputStream.java
@@ -30,8 +30,9 @@ public class ExposedByteArrayInputStream extends ByteArrayInputStream{
super(buf);
}
- /** Read all remaining bytes.
- * @throws IOException */
+ /**
+ * Read all remaining bytes.
+ */
@SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Returns internal buffer by design")
public byte[] readAll() throws IOException {
if (pos == 0 && count == buf.length) {
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayOutputStream.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayOutputStream.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayOutputStream.java
index e2c7e42..e4a8062 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayOutputStream.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayOutputStream.java
@@ -62,8 +62,6 @@ public class ExposedByteArrayOutputStream extends ByteArrayOutputStream {
* no content copy will be involved.
*
* <p><i>Note: After passing any byte array to this method, it must not be modified again.</i>
- *
- * @throws IOException
*/
@SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Takes ownership of input buffer")
public void writeAndOwn(byte[] b) throws IOException {
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcsUtil.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcsUtil.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcsUtil.java
index ce4604b..54a963b 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcsUtil.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcsUtil.java
@@ -301,7 +301,6 @@ public class GcsUtil {
*
* @param path the GCS filename to read from
* @return a SeekableByteChannel that can read the object data
- * @throws IOException
*/
public SeekableByteChannel open(GcsPath path)
throws IOException {
@@ -319,7 +318,6 @@ public class GcsUtil {
* @param path the GCS file to write to
* @param type the type of object, eg "text/plain".
* @return a Callable object that encloses the operation.
- * @throws IOException
*/
public WritableByteChannel create(GcsPath path,
String type) throws IOException {
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/util/MovingFunction.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/MovingFunction.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/MovingFunction.java
index 7b30d34..a8239ce 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/MovingFunction.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/MovingFunction.java
@@ -25,8 +25,8 @@ import org.apache.beam.sdk.transforms.Combine;
/**
* Keep track of the moving minimum/maximum/sum of sampled long values. The minimum/maximum/sum
- * is over at most the last {@link #samplePeriodMs}, and is updated every
- * {@link #sampleUpdateMs}.
+ * is over at most the user-specified last {@code samplePeriodMs}, and is updated every
+ * {@code sampleUpdateMs}.
*/
public class MovingFunction {
/**
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/util/PubsubClient.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/PubsubClient.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/PubsubClient.java
index 1ac5511..06b776b 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/PubsubClient.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/PubsubClient.java
@@ -90,10 +90,10 @@ public abstract class PubsubClient implements Closeable {
* <p>If {@code timestampLabel} is non-{@literal null} then the message attributes must contain
* that label, and the value of that label will be taken as the timestamp.
* Otherwise the timestamp will be taken from the Pubsub publish timestamp {@code
- * pubsubTimestamp}. Throw {@link IllegalArgumentException} if the timestamp cannot be
- * recognized as a ms-since-unix-epoch or RFC3339 time.
+ * pubsubTimestamp}.
*
- * @throws IllegalArgumentException
+ * @throws IllegalArgumentException if the timestamp cannot be recognized as a ms-since-unix-epoch
+ * or RFC3339 time.
*/
protected static long extractTimestamp(
@Nullable String timestampLabel,
@@ -115,7 +115,7 @@ public abstract class PubsubClient implements Closeable {
"Cannot interpret value of label %s as timestamp: %s",
timestampLabel, value);
}
- return timestampMsSinceEpoch == null ? 0 : timestampMsSinceEpoch;
+ return timestampMsSinceEpoch;
}
/**
@@ -443,8 +443,6 @@ public abstract class PubsubClient implements Closeable {
/**
* Publish {@code outgoingMessages} to Pubsub {@code topic}. Return number of messages
* published.
- *
- * @throws IOException
*/
public abstract int publish(TopicPath topic, List<OutgoingMessage> outgoingMessages)
throws IOException;
@@ -454,8 +452,6 @@ public abstract class PubsubClient implements Closeable {
* Return the received messages, or empty collection if none were available. Does not
* wait for messages to arrive if {@code returnImmediately} is {@literal true}.
* Returned messages will record their request time as {@code requestTimeMsSinceEpoch}.
- *
- * @throws IOException
*/
public abstract List<IncomingMessage> pull(
long requestTimeMsSinceEpoch,
@@ -466,8 +462,6 @@ public abstract class PubsubClient implements Closeable {
/**
* Acknowldege messages from {@code subscription} with {@code ackIds}.
- *
- * @throws IOException
*/
public abstract void acknowledge(SubscriptionPath subscription, List<String> ackIds)
throws IOException;
@@ -475,8 +469,6 @@ public abstract class PubsubClient implements Closeable {
/**
* Modify the ack deadline for messages from {@code subscription} with {@code ackIds} to
* be {@code deadlineSeconds} from now.
- *
- * @throws IOException
*/
public abstract void modifyAckDeadline(
SubscriptionPath subscription, List<String> ackIds,
@@ -484,29 +476,21 @@ public abstract class PubsubClient implements Closeable {
/**
* Create {@code topic}.
- *
- * @throws IOException
*/
public abstract void createTopic(TopicPath topic) throws IOException;
/*
* Delete {@code topic}.
- *
- * @throws IOException
*/
public abstract void deleteTopic(TopicPath topic) throws IOException;
/**
* Return a list of topics for {@code project}.
- *
- * @throws IOException
*/
public abstract List<TopicPath> listTopics(ProjectPath project) throws IOException;
/**
* Create {@code subscription} to {@code topic}.
- *
- * @throws IOException
*/
public abstract void createSubscription(
TopicPath topic, SubscriptionPath subscription, int ackDeadlineSeconds) throws IOException;
@@ -514,8 +498,6 @@ public abstract class PubsubClient implements Closeable {
/**
* Create a random subscription for {@code topic}. Return the {@link SubscriptionPath}. It
* is the responsibility of the caller to later delete the subscription.
- *
- * @throws IOException
*/
public SubscriptionPath createRandomSubscription(
ProjectPath project, TopicPath topic, int ackDeadlineSeconds) throws IOException {
@@ -529,23 +511,17 @@ public abstract class PubsubClient implements Closeable {
/**
* Delete {@code subscription}.
- *
- * @throws IOException
*/
public abstract void deleteSubscription(SubscriptionPath subscription) throws IOException;
/**
* Return a list of subscriptions for {@code topic} in {@code project}.
- *
- * @throws IOException
*/
public abstract List<SubscriptionPath> listSubscriptions(ProjectPath project, TopicPath topic)
throws IOException;
/**
* Return the ack deadline, in seconds, for {@code subscription}.
- *
- * @throws IOException
*/
public abstract int ackDeadlineSeconds(SubscriptionPath subscription) throws IOException;
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/util/StringUtils.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/StringUtils.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/StringUtils.java
index 1c52c1f..3ff8448 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/StringUtils.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/StringUtils.java
@@ -119,8 +119,8 @@ public class StringUtils {
*
* <p>Examples:
* <ul>
- * <li>{@code some.package.Word.SummaryDoFn} -> "Summary"
- * <li>{@code another.package.PairingFn} -> "Pairing"
+ * <li>{@code some.package.Word.SummaryDoFn} becomes "Summary"
+ * <li>{@code another.package.PairingFn} becomes "Pairing"
* </ul>
*
* @throws IllegalArgumentException if the class is anonymous
@@ -143,8 +143,8 @@ public class StringUtils {
*
* <p>Examples:
* <ul>
- * <li>{@code some.package.Word.Summary} -> "Word.Summary"
- * <li>{@code another.package.Pairing.Bound} -> "Pairing"
+ * <li>{@code some.package.Word.Summary} becomes "Word.Summary"
+ * <li>{@code another.package.Pairing.Bound} becomes "Pairing"
* </ul>
*/
public static String approximatePTransformName(Class<?> clazz) {
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/util/TimerInternals.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/TimerInternals.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/TimerInternals.java
index 8015116..743f3f7 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/TimerInternals.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/TimerInternals.java
@@ -128,15 +128,17 @@ public interface TimerInternals {
* </ol>
*
* <p>In pictures:
- * <pre>
+ * <pre>{@code
* | | | | |
* | | D | C | B | A
* | | | | |
* GIWM <= GOWM <= LOWM <= LIWM <= GIWM
* (next stage)
* -------------------------------------------------> event time
- * </pre>
- * where
+ * }</pre>
+ *
+ * <p>where
+ *
* <ul>
* <li> LOWM = local output water mark.
* <li> GOWM = global output water mark.
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/StateNamespace.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/StateNamespace.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/StateNamespace.java
index 9b27b1d..04440cb 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/StateNamespace.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/StateNamespace.java
@@ -22,17 +22,17 @@ import java.io.IOException;
/**
* A namespace used for scoping state stored with {@link StateInternals}.
*
- * <p>Instances of {@code StateNamespace} are guaranteed to have a {@link #hashCode} and
- * {@link #equals} that uniquely identify the namespace.
+ * <p>Instances of {@link StateNamespace} are guaranteed to have a {@link Object#hashCode} and
+ * {@link Object#equals} that uniquely identify the namespace.
*/
public interface StateNamespace {
/**
* Return a {@link String} representation of the key. It is guaranteed that this
- * {@code String} will uniquely identify the key.
+ * {@link String} will uniquely identify the key.
*
- * <p>This will encode the actual namespace as a {@code String}. It is
- * preferable to use the {@code StateNamespace} object when possible.
+ * <p>This will encode the actual namespace as a {@link String}. It is
+ * preferable to use the {@link StateNamespace} object when possible.
*
* <p>The string produced by the standard implementations will not contain a '+' character. This
* enables adding a '+' between the actual namespace and other information, if needed, to separate
@@ -46,11 +46,11 @@ public interface StateNamespace {
void appendTo(Appendable sb) throws IOException;
/**
- * Return an {@code Object} to use as a key in a cache.
+ * Return an {@link Object} to use as a key in a cache.
*
* <p>Different namespaces may use the same key in order to be treated as a unit in the cache.
- * The {@code Object}'s {@code hashCode} and {@code equals} methods will be used to determine
- * equality.
+ * The {@link Object}'s {@link Object#hashCode} and {@link Object#equals} methods will be used to
+ * determine equality.
*/
Object getCacheKey();
}
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PDone.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PDone.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PDone.java
index 83d6a92..9e8cae4 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PDone.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PDone.java
@@ -24,7 +24,7 @@ import org.apache.beam.sdk.transforms.PTransform;
/**
* {@link PDone} is the output of a {@link PTransform} that has a trivial result,
- * such as a {@link Write}.
+ * such as a {@link org.apache.beam.sdk.io.Write}.
*/
public class PDone extends POutputValueBase {
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/datastore/DatastoreV1.java
----------------------------------------------------------------------
diff --git a/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/datastore/DatastoreV1.java b/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/datastore/DatastoreV1.java
index 3727f92..1d1075c 100644
--- a/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/datastore/DatastoreV1.java
+++ b/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/datastore/DatastoreV1.java
@@ -165,7 +165,7 @@ import org.slf4j.LoggerFactory;
* read <a href="https://cloud.google.com/datastore/docs/concepts/entities">Entities, Properties,
* and Keys</a> for more information about {@code Entity} keys.
*
- * <p><h3>Permissions</h3>
+ * <h3>Permissions</h3>
* Permission requirements depend on the {@code PipelineRunner} that is used to execute the
* Dataflow job. Please refer to the documentation of corresponding {@code PipelineRunner}s for
* more details.
http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/717b431c/sdks/java/io/kinesis/src/main/java/org/apache/beam/sdk/io/kinesis/KinesisIO.java
----------------------------------------------------------------------
diff --git a/sdks/java/io/kinesis/src/main/java/org/apache/beam/sdk/io/kinesis/KinesisIO.java b/sdks/java/io/kinesis/src/main/java/org/apache/beam/sdk/io/kinesis/KinesisIO.java
index 945eff6..91939d4 100644
--- a/sdks/java/io/kinesis/src/main/java/org/apache/beam/sdk/io/kinesis/KinesisIO.java
+++ b/sdks/java/io/kinesis/src/main/java/org/apache/beam/sdk/io/kinesis/KinesisIO.java
@@ -40,32 +40,29 @@ import org.joda.time.Instant;
* It follows the usage conventions laid out by other *IO classes like
* BigQueryIO or PubsubIOLet's see how you can set up a simple Pipeline, which reads from Kinesis:
*
- * <pre>{@code}
+ * <pre>{@code
* p.
* apply(KinesisIO.Read.
* from("streamName", InitialPositionInStream.LATEST).
* using("AWS_KEY", _"AWS_SECRET", STREAM_REGION).
* apply( ... ) // other transformations
- *</pre>
- * </p>
+ * }</pre>
*
- * <p>
- * As you can see you need to provide 3 things:
+ * <p>As you can see you need to provide 3 things:
* <ul>
* <li>name of the stream you're going to read</li>
- * <li>position in the stream where reading should start. There are two options:</li>
+ * <li>position in the stream where reading should start. There are two options:
* <ul>
* <li>{@link InitialPositionInStream#LATEST} - reading will begin from end of the stream</li>
* <li>{@link InitialPositionInStream#TRIM_HORIZON} - reading will begin at
* the very beginning of the stream</li>
- * </ul>
- * <li>data used to initialize {@link AmazonKinesis} client</li>
+ * </ul></li>
+ * <li>data used to initialize {@link AmazonKinesis} client:
* <ul>
* <li>credentials (aws key, aws secret)</li>
* <li>region where the stream is located</li>
- * </ul>
+ * </ul></li>
* </ul>
- * </p>
*
* <p>In case when you want to set up {@link AmazonKinesis} client by your own
* (for example if you're using more sophisticated authorization methods like Amazon STS, etc.)
@@ -73,35 +70,33 @@ import org.joda.time.Instant;
*
* <pre>{@code
* public class MyCustomKinesisClientProvider implements KinesisClientProvider {
- * @Override
+ * {@literal @}Override
* public AmazonKinesis get() {
* // set up your client here
* }
- * }}
- * </pre>
+ * }
+ * }</pre>
*
- * Usage is pretty straightforward:
+ * <p>Usage is pretty straightforward:
*
- * <pre>{@code}
+ * <pre>{@code
* p.
* apply(KinesisIO.Read.
* from("streamName", InitialPositionInStream.LATEST).
* using(MyCustomKinesisClientProvider()).
* apply( ... ) // other transformations
- * </pre>
- * </p>
+ * }</pre>
*
* <p>There\u2019s also possibility to start reading using arbitrary point in time -
* in this case you need to provide {@link Instant} object:
*
- * <pre>{@code}
+ * <pre>{@code
* p.
* apply(KinesisIO.Read.
* from("streamName", instant).
* using(MyCustomKinesisClientProvider()).
* apply( ... ) // other transformations
- * </pre>
- * </p>
+ * }</pre>
*
*/
public final class KinesisIO {