You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by ke...@apache.org on 2017/04/25 17:30:12 UTC
[17/50] [abbrv] beam git commit: Fix javadoc warnings
Fix javadoc warnings
Project: http://git-wip-us.apache.org/repos/asf/beam/repo
Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/7cf06f59
Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/7cf06f59
Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/7cf06f59
Branch: refs/heads/jstorm-runner
Commit: 7cf06f591f8e43a5d327e8aa2998c040677d169e
Parents: 9b8f230
Author: Isma�l Mej�a <ie...@apache.org>
Authored: Mon Apr 17 01:06:56 2017 +0200
Committer: Jean-Baptiste Onofr� <jb...@apache.org>
Committed: Mon Apr 17 11:06:07 2017 +0200
----------------------------------------------------------------------
.../org/apache/beam/runners/apex/ApexYarnLauncher.java | 2 --
.../apache/beam/runners/direct/ModelEnforcement.java | 13 ++++++-------
.../beam/runners/direct/TransformEvaluatorFactory.java | 10 +++++-----
.../src/main/java/org/apache/beam/sdk/io/AvroIO.java | 13 ++++++-------
.../src/main/java/org/apache/beam/sdk/io/Sink.java | 2 +-
.../main/java/org/apache/beam/sdk/io/jdbc/JdbcIO.java | 2 --
.../apache/beam/sdk/io/mongodb/MongoDbGridFSIO.java | 7 +------
7 files changed, 19 insertions(+), 30 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/beam/blob/7cf06f59/runners/apex/src/main/java/org/apache/beam/runners/apex/ApexYarnLauncher.java
----------------------------------------------------------------------
diff --git a/runners/apex/src/main/java/org/apache/beam/runners/apex/ApexYarnLauncher.java b/runners/apex/src/main/java/org/apache/beam/runners/apex/ApexYarnLauncher.java
index 198b9bf..b84144c 100644
--- a/runners/apex/src/main/java/org/apache/beam/runners/apex/ApexYarnLauncher.java
+++ b/runners/apex/src/main/java/org/apache/beam/runners/apex/ApexYarnLauncher.java
@@ -296,8 +296,6 @@ public class ApexYarnLauncher {
/**
* Transfer the properties to the configuration object.
- * @param conf
- * @param props
*/
public static void addProperties(Configuration conf, Properties props) {
for (final String propertyName : props.stringPropertyNames()) {
http://git-wip-us.apache.org/repos/asf/beam/blob/7cf06f59/runners/direct-java/src/main/java/org/apache/beam/runners/direct/ModelEnforcement.java
----------------------------------------------------------------------
diff --git a/runners/direct-java/src/main/java/org/apache/beam/runners/direct/ModelEnforcement.java b/runners/direct-java/src/main/java/org/apache/beam/runners/direct/ModelEnforcement.java
index 25226f7..96dbc2b 100644
--- a/runners/direct-java/src/main/java/org/apache/beam/runners/direct/ModelEnforcement.java
+++ b/runners/direct-java/src/main/java/org/apache/beam/runners/direct/ModelEnforcement.java
@@ -17,7 +17,6 @@
*/
package org.apache.beam.runners.direct;
-import org.apache.beam.runners.direct.DirectRunner.CommittedBundle;
import org.apache.beam.sdk.coders.Coder;
import org.apache.beam.sdk.transforms.AppliedPTransform;
import org.apache.beam.sdk.util.WindowedValue;
@@ -28,9 +27,9 @@ import org.apache.beam.sdk.values.PCollection;
*
* <p>ModelEnforcement is performed on a per-element and per-bundle basis. The
* {@link ModelEnforcement} is provided with the input bundle as part of
- * {@link ModelEnforcementFactory#forBundle(CommittedBundle, AppliedPTransform)}, each element
- * before and after that element is provided to an underlying {@link TransformEvaluator}, and the
- * output {@link TransformResult} and committed output bundles after the
+ * {@link ModelEnforcementFactory#forBundle(DirectRunner.CommittedBundle, AppliedPTransform)} each
+ * element before and after that element is provided to an underlying {@link TransformEvaluator},
+ * and the output {@link TransformResult} and committed output bundles after the
* {@link TransformEvaluator} has completed.
*
* <p>Typically, {@link ModelEnforcement} will obtain required metadata (such as the {@link Coder}
@@ -54,10 +53,10 @@ public interface ModelEnforcement<T> {
/**
* Called after a bundle has been completed and {@link TransformEvaluator#finishBundle()} has been
* called, producing the provided {@link TransformResult} and
- * {@link CommittedBundle output bundles}.
+ * {@link DirectRunner.CommittedBundle output bundles}.
*/
void afterFinish(
- CommittedBundle<T> input,
+ DirectRunner.CommittedBundle<T> input,
TransformResult<T> result,
- Iterable<? extends CommittedBundle<?>> outputs);
+ Iterable<? extends DirectRunner.CommittedBundle<?>> outputs);
}
http://git-wip-us.apache.org/repos/asf/beam/blob/7cf06f59/runners/direct-java/src/main/java/org/apache/beam/runners/direct/TransformEvaluatorFactory.java
----------------------------------------------------------------------
diff --git a/runners/direct-java/src/main/java/org/apache/beam/runners/direct/TransformEvaluatorFactory.java b/runners/direct-java/src/main/java/org/apache/beam/runners/direct/TransformEvaluatorFactory.java
index efbe137..c7bc46f 100644
--- a/runners/direct-java/src/main/java/org/apache/beam/runners/direct/TransformEvaluatorFactory.java
+++ b/runners/direct-java/src/main/java/org/apache/beam/runners/direct/TransformEvaluatorFactory.java
@@ -18,7 +18,6 @@
package org.apache.beam.runners.direct;
import javax.annotation.Nullable;
-import org.apache.beam.runners.direct.DirectRunner.CommittedBundle;
import org.apache.beam.sdk.Pipeline;
import org.apache.beam.sdk.io.Read;
import org.apache.beam.sdk.transforms.AppliedPTransform;
@@ -48,13 +47,14 @@ public interface TransformEvaluatorFactory {
*/
@Nullable
<InputT> TransformEvaluator<InputT> forApplication(
- AppliedPTransform<?, ?, ?> application, CommittedBundle<?> inputBundle)
+ AppliedPTransform<?, ?, ?> application, DirectRunner.CommittedBundle<?> inputBundle)
throws Exception;
/**
- * Cleans up any state maintained by this {@link TransformEvaluatorFactory}. Called after a {@link
- * Pipeline} is shut down. No more calls to {@link #forApplication(AppliedPTransform,
- * CommittedBundle)} will be made after a call to {@link #cleanup()}.
+ * Cleans up any state maintained by this {@link TransformEvaluatorFactory}. Called after a
+ * {@link Pipeline} is shut down. No more calls to
+ * {@link #forApplication(AppliedPTransform, DirectRunner.CommittedBundle)} will be made after
+ * a call to {@link #cleanup()}.
*/
void cleanup() throws Exception;
}
http://git-wip-us.apache.org/repos/asf/beam/blob/7cf06f59/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 a41c9f5..33fe323 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
@@ -40,7 +40,6 @@ import org.apache.avro.reflect.ReflectData;
import org.apache.beam.sdk.coders.AvroCoder;
import org.apache.beam.sdk.coders.Coder;
import org.apache.beam.sdk.coders.VoidCoder;
-import org.apache.beam.sdk.io.FileBasedSink.FilenamePolicy;
import org.apache.beam.sdk.io.Read.Bounded;
import org.apache.beam.sdk.options.PipelineOptions;
import org.apache.beam.sdk.runners.PipelineRunner;
@@ -91,8 +90,8 @@ import org.apache.beam.sdk.values.PDone;
* the path of the file to write to (e.g., a local filename or sharded
* filename pattern if running locally, or a Google Cloud Storage
* filename or sharded filename pattern of the form
- * {@code "gs://<bucket>/<filepath>"}). {@link AvroIO.Write#to(FilenamePolicy)} can also be used
- * to specify a custom file naming policy.
+ * {@code "gs://<bucket>/<filepath>"}). {@link AvroIO.Write#to(FileBasedSink.FilenamePolicy)}
+ * can also be used to specify a custom file naming policy.
*
* <p>By default, all input is put into the global window before writing. If per-window writes are
* desired - for example, when using a streaming runner -
@@ -384,7 +383,7 @@ public class AvroIO {
* Returns a {@link PTransform} that writes to the file(s) specified by the provided
* {@link FileBasedSink.FilenamePolicy}.
*/
- public static Bound<GenericRecord> to(FilenamePolicy filenamePolicy) {
+ public static Bound<GenericRecord> to(FileBasedSink.FilenamePolicy filenamePolicy) {
return new Bound<>(GenericRecord.class).to(filenamePolicy);
}
@@ -517,7 +516,7 @@ public class AvroIO {
/** An option to indicate if output validation is desired. Default is true. */
final boolean validate;
final boolean windowedWrites;
- FilenamePolicy filenamePolicy;
+ FileBasedSink.FilenamePolicy filenamePolicy;
/**
* The codec used to encode the blocks in the Avro file. String value drawn from those in
@@ -555,7 +554,7 @@ public class AvroIO {
SerializableAvroCodecFactory codec,
Map<String, Object> metadata,
boolean windowedWrites,
- FilenamePolicy filenamePolicy) {
+ FileBasedSink.FilenamePolicy filenamePolicy) {
super(name);
this.filenamePrefix = filenamePrefix;
this.filenameSuffix = filenameSuffix;
@@ -607,7 +606,7 @@ public class AvroIO {
filenamePolicy);
}
- public Bound<T> to(FilenamePolicy filenamePolicy) {
+ public Bound<T> to(FileBasedSink.FilenamePolicy filenamePolicy) {
return new Bound<>(
name,
filenamePrefix,
http://git-wip-us.apache.org/repos/asf/beam/blob/7cf06f59/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Sink.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Sink.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Sink.java
index d53c6ce..ba1afbb 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Sink.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Sink.java
@@ -249,7 +249,7 @@ public abstract class Sink<T> implements Serializable, HasDisplayData {
* not interfere with the output of other Writers, as a bundle may be executed many times for
* fault tolerance. See {@link Sink} for more information about bundle ids.
*
- * <p></p>The window and paneInfo arguments are populated when windowed writes are requested.
+ * <p>The window and paneInfo arguments are populated when windowed writes are requested.
* shard and numbShards are populated for the case of static sharding. In cases where the
* runner is dynamically picking sharding, shard and numShards might both be set to -1.
*/
http://git-wip-us.apache.org/repos/asf/beam/blob/7cf06f59/sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcIO.java
----------------------------------------------------------------------
diff --git a/sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcIO.java b/sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcIO.java
index 8fdbeb0..05a30a4 100644
--- a/sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcIO.java
+++ b/sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcIO.java
@@ -227,8 +227,6 @@ public class JdbcIO {
*
* <p>NOTE - The "user" and "password" properties can be add via {@link #withUsername(String)},
* {@link #withPassword(String)}, so they do not need to be included here.
- * @param connectionProperties
- * @return
*/
public DataSourceConfiguration withConnectionProperties(String connectionProperties) {
checkArgument(connectionProperties != null, "DataSourceConfiguration.create(driver, url)"
http://git-wip-us.apache.org/repos/asf/beam/blob/7cf06f59/sdks/java/io/mongodb/src/main/java/org/apache/beam/sdk/io/mongodb/MongoDbGridFSIO.java
----------------------------------------------------------------------
diff --git a/sdks/java/io/mongodb/src/main/java/org/apache/beam/sdk/io/mongodb/MongoDbGridFSIO.java b/sdks/java/io/mongodb/src/main/java/org/apache/beam/sdk/io/mongodb/MongoDbGridFSIO.java
index 919fda3..e193d29 100644
--- a/sdks/java/io/mongodb/src/main/java/org/apache/beam/sdk/io/mongodb/MongoDbGridFSIO.java
+++ b/sdks/java/io/mongodb/src/main/java/org/apache/beam/sdk/io/mongodb/MongoDbGridFSIO.java
@@ -130,14 +130,11 @@ public class MongoDbGridFSIO {
/**
* Output the object. The default timestamp will be the GridFSDBFile
* creation timestamp.
- * @param output
*/
void output(T output);
/**
* Output the object using the specified timestamp.
- * @param output
- * @param timestamp
*/
void output(T output, Instant timestamp);
}
@@ -145,7 +142,6 @@ public class MongoDbGridFSIO {
/**
* Interface for the parser that is used to parse the GridFSDBFile into
* the appropriate types.
- * @param <T>
*/
public interface Parser<T> extends Serializable {
void parse(GridFSDBFile input, ParserCallback<T> callback) throws IOException;
@@ -533,7 +529,6 @@ public class MongoDbGridFSIO {
/**
* Function that is called to write the data to the give GridFS OutputStream.
- * @param <T>
*/
public interface WriteFn<T> extends Serializable {
/**
@@ -624,6 +619,7 @@ public class MongoDbGridFSIO {
return PDone.in(input.getPipeline());
}
}
+
private static class GridFsWriteFn<T> extends DoFn<T, Void> {
private final Write<T> spec;
@@ -686,6 +682,5 @@ public class MongoDbGridFSIO {
}
}
}
-
}
}