beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dhalp...@apache.org
Subject [1/2] incubator-beam git commit: Checkstyle: enforce package-info.java presence
Date Wed, 20 Jul 2016 16:16:37 GMT
Repository: incubator-beam
Updated Branches:
  refs/heads/master 64df4f20a -> c4ad11832


Checkstyle: enforce package-info.java presence

Ignores tests and examples


Project: http://git-wip-us.apache.org/repos/asf/incubator-beam/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-beam/commit/ad6ee018
Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam/tree/ad6ee018
Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam/diff/ad6ee018

Branch: refs/heads/master
Commit: ad6ee01825740ee47f25ca036fa5f352375bbe6e
Parents: 64df4f2
Author: Dan Halperin <dhalperi@google.com>
Authored: Mon Jul 18 23:40:13 2016 -0700
Committer: Dan Halperin <dhalperi@google.com>
Committed: Wed Jul 20 09:16:27 2016 -0700

----------------------------------------------------------------------
 pom.xml                                         |  1 +
 .../apache/beam/runners/core/package-info.java  | 22 ++++++++++++++++++
 .../beam/sdk/util/common/package-info.java      | 20 ++++++++++++++++
 .../org/apache/beam/sdk/util/package-info.java  | 20 ++++++++++++++++
 .../runners/dataflow/options/package-info.java  | 22 ++++++++++++++++++
 .../beam/runners/dataflow/package-info.java     | 22 ++++++++++++++++++
 .../runners/dataflow/testing/package-info.java  | 24 ++++++++++++++++++++
 .../runners/dataflow/util/package-info.java     | 20 ++++++++++++++++
 .../runners/spark/aggregators/package-info.java | 20 ++++++++++++++++
 .../beam/runners/spark/coders/package-info.java | 22 ++++++++++++++++++
 .../runners/spark/io/hadoop/package-info.java   | 22 ++++++++++++++++++
 .../beam/runners/spark/io/package-info.java     | 22 ++++++++++++++++++
 .../apache/beam/runners/spark/package-info.java | 22 ++++++++++++++++++
 .../runners/spark/translation/package-info.java | 22 ++++++++++++++++++
 .../translation/streaming/package-info.java     | 22 ++++++++++++++++++
 .../beam/runners/spark/util/package-info.java   | 22 ++++++++++++++++++
 .../src/main/resources/beam/checkstyle.xml      |  3 +++
 .../src/main/resources/beam/suppressions.xml    | 24 ++++++++++++++++++++
 .../beam/sdk/util/common/package-info.java      |  3 ++-
 .../beam/sdk/util/gcsfs/package-info.java       |  3 ++-
 .../org/apache/beam/sdk/util/package-info.java  |  3 ++-
 .../beam/sdk/util/state/package-info.java       | 22 ++++++++++++++++++
 .../extensions/joinlibrary/package-info.java    | 23 +++++++++++++++++++
 .../apache/beam/sdk/io/hdfs/package-info.java   | 22 ++++++++++++++++++
 .../sdk/io/hdfs/simpleauth/package-info.java    | 22 ++++++++++++++++++
 .../apache/beam/sdk/io/kafka/package-info.java  | 22 ++++++++++++++++++
 .../microbenchmarks/coders/package-info.java    | 22 ++++++++++++++++++
 .../transforms/package-info.java                | 22 ++++++++++++++++++
 28 files changed, 513 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index e51f3e6..5e89403 100644
--- a/pom.xml
+++ b/pom.xml
@@ -666,6 +666,7 @@
           <configuration>
             <configLocation>beam/checkstyle.xml</configLocation>
             <headerLocation>beam/header-file.txt</headerLocation>
+            <suppressionsLocation>beam/suppressions.xml</suppressionsLocation>
             <consoleOutput>true</consoleOutput>
             <failOnViolation>true</failOnViolation>
             <includeResources>false</includeResources>

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/core-java/src/main/java/org/apache/beam/runners/core/package-info.java
----------------------------------------------------------------------
diff --git a/runners/core-java/src/main/java/org/apache/beam/runners/core/package-info.java
b/runners/core-java/src/main/java/org/apache/beam/runners/core/package-info.java
new file mode 100644
index 0000000..d250a6a
--- /dev/null
+++ b/runners/core-java/src/main/java/org/apache/beam/runners/core/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Provides utilities for Beam runner authors.
+ */
+package org.apache.beam.runners.core;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/core-java/src/main/java/org/apache/beam/sdk/util/common/package-info.java
----------------------------------------------------------------------
diff --git a/runners/core-java/src/main/java/org/apache/beam/sdk/util/common/package-info.java
b/runners/core-java/src/main/java/org/apache/beam/sdk/util/common/package-info.java
new file mode 100644
index 0000000..1ea8af8
--- /dev/null
+++ b/runners/core-java/src/main/java/org/apache/beam/sdk/util/common/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** Defines utilities shared by multiple PipelineRunner implementations. */
+package org.apache.beam.sdk.util.common;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/core-java/src/main/java/org/apache/beam/sdk/util/package-info.java
----------------------------------------------------------------------
diff --git a/runners/core-java/src/main/java/org/apache/beam/sdk/util/package-info.java b/runners/core-java/src/main/java/org/apache/beam/sdk/util/package-info.java
new file mode 100644
index 0000000..b4772f3
--- /dev/null
+++ b/runners/core-java/src/main/java/org/apache/beam/sdk/util/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** Defines utilities that can be used by Beam runners. */
+package org.apache.beam.sdk.util;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/package-info.java
----------------------------------------------------------------------
diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/package-info.java
b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/package-info.java
new file mode 100644
index 0000000..9635ad6
--- /dev/null
+++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Provides {@link org.apache.beam.sdk.options.PipelineOptions} specific to Google Cloud
Dataflow.
+ */
+package org.apache.beam.runners.dataflow.options;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/package-info.java
----------------------------------------------------------------------
diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/package-info.java
b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/package-info.java
new file mode 100644
index 0000000..4ae2c15
--- /dev/null
+++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Provides a Beam runner that executes pipelines on the Google Cloud Dataflow service.
+ */
+package org.apache.beam.runners.dataflow;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/testing/package-info.java
----------------------------------------------------------------------
diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/testing/package-info.java
b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/testing/package-info.java
new file mode 100644
index 0000000..98c963a
--- /dev/null
+++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/testing/package-info.java
@@ -0,0 +1,24 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Provides utilities for integration testing and {@link
+ * org.apache.beam.sdk.testing.RunnableOnService} tests of the Google Cloud Dataflow
+ * runner.
+ */
+package org.apache.beam.runners.dataflow.testing;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/package-info.java
----------------------------------------------------------------------
diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/package-info.java
b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/package-info.java
new file mode 100644
index 0000000..47f7c87
--- /dev/null
+++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** Provides miscellaneous internal utilities used by the Google Cloud Dataflow runner. */
+package org.apache.beam.runners.dataflow.util;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/spark/src/main/java/org/apache/beam/runners/spark/aggregators/package-info.java
----------------------------------------------------------------------
diff --git a/runners/spark/src/main/java/org/apache/beam/runners/spark/aggregators/package-info.java
b/runners/spark/src/main/java/org/apache/beam/runners/spark/aggregators/package-info.java
new file mode 100644
index 0000000..14264f1
--- /dev/null
+++ b/runners/spark/src/main/java/org/apache/beam/runners/spark/aggregators/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** Provides internal utilities for implementing Beam aggregators using Spark accumulators.
*/
+package org.apache.beam.runners.spark.aggregators;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/spark/src/main/java/org/apache/beam/runners/spark/coders/package-info.java
----------------------------------------------------------------------
diff --git a/runners/spark/src/main/java/org/apache/beam/runners/spark/coders/package-info.java
b/runners/spark/src/main/java/org/apache/beam/runners/spark/coders/package-info.java
new file mode 100644
index 0000000..8868ed0
--- /dev/null
+++ b/runners/spark/src/main/java/org/apache/beam/runners/spark/coders/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Beam coders and coder-related utilities for running on Apache Spark.
+ */
+package org.apache.beam.runners.spark.coders;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/spark/src/main/java/org/apache/beam/runners/spark/io/hadoop/package-info.java
----------------------------------------------------------------------
diff --git a/runners/spark/src/main/java/org/apache/beam/runners/spark/io/hadoop/package-info.java
b/runners/spark/src/main/java/org/apache/beam/runners/spark/io/hadoop/package-info.java
new file mode 100644
index 0000000..70cd0f3
--- /dev/null
+++ b/runners/spark/src/main/java/org/apache/beam/runners/spark/io/hadoop/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Spark-specific transforms for reading from and writing to Hadoop file systems (HDFS).
+ */
+package org.apache.beam.runners.spark.io.hadoop;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/spark/src/main/java/org/apache/beam/runners/spark/io/package-info.java
----------------------------------------------------------------------
diff --git a/runners/spark/src/main/java/org/apache/beam/runners/spark/io/package-info.java
b/runners/spark/src/main/java/org/apache/beam/runners/spark/io/package-info.java
new file mode 100644
index 0000000..1478229
--- /dev/null
+++ b/runners/spark/src/main/java/org/apache/beam/runners/spark/io/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Spark-specific transforms for I/O.
+ */
+package org.apache.beam.runners.spark.io;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/spark/src/main/java/org/apache/beam/runners/spark/package-info.java
----------------------------------------------------------------------
diff --git a/runners/spark/src/main/java/org/apache/beam/runners/spark/package-info.java b/runners/spark/src/main/java/org/apache/beam/runners/spark/package-info.java
new file mode 100644
index 0000000..a4d0da1
--- /dev/null
+++ b/runners/spark/src/main/java/org/apache/beam/runners/spark/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Internal implementation of the Beam runner for Apache Spark.
+ */
+package org.apache.beam.runners.spark;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/spark/src/main/java/org/apache/beam/runners/spark/translation/package-info.java
----------------------------------------------------------------------
diff --git a/runners/spark/src/main/java/org/apache/beam/runners/spark/translation/package-info.java
b/runners/spark/src/main/java/org/apache/beam/runners/spark/translation/package-info.java
new file mode 100644
index 0000000..aa68bc8
--- /dev/null
+++ b/runners/spark/src/main/java/org/apache/beam/runners/spark/translation/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Internal translators for running Beam pipelines on Spark.
+ */
+package org.apache.beam.runners.spark.translation;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/spark/src/main/java/org/apache/beam/runners/spark/translation/streaming/package-info.java
----------------------------------------------------------------------
diff --git a/runners/spark/src/main/java/org/apache/beam/runners/spark/translation/streaming/package-info.java
b/runners/spark/src/main/java/org/apache/beam/runners/spark/translation/streaming/package-info.java
new file mode 100644
index 0000000..c4fa9b9
--- /dev/null
+++ b/runners/spark/src/main/java/org/apache/beam/runners/spark/translation/streaming/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Internal utilities to translate Beam pipelines to Spark streaming.
+ */
+package org.apache.beam.runners.spark.translation.streaming;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/runners/spark/src/main/java/org/apache/beam/runners/spark/util/package-info.java
----------------------------------------------------------------------
diff --git a/runners/spark/src/main/java/org/apache/beam/runners/spark/util/package-info.java
b/runners/spark/src/main/java/org/apache/beam/runners/spark/util/package-info.java
new file mode 100644
index 0000000..3ea89ac
--- /dev/null
+++ b/runners/spark/src/main/java/org/apache/beam/runners/spark/util/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Internal utilities to translate Beam pipelines to Spark.
+ */
+package org.apache.beam.runners.spark.util;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/sdks/java/build-tools/src/main/resources/beam/checkstyle.xml
----------------------------------------------------------------------
diff --git a/sdks/java/build-tools/src/main/resources/beam/checkstyle.xml b/sdks/java/build-tools/src/main/resources/beam/checkstyle.xml
index 63bab09..eb09145 100644
--- a/sdks/java/build-tools/src/main/resources/beam/checkstyle.xml
+++ b/sdks/java/build-tools/src/main/resources/beam/checkstyle.xml
@@ -60,6 +60,9 @@ page at http://checkstyle.sourceforge.net/config.html -->
     <property name="checkFormat" value="$1"/>
   </module>
 
+  <!-- Check that every module has a package-info.java -->
+  <module name="JavadocPackage"/>
+
   <!-- All Java AST specific tests live under TreeWalker module. -->
   <module name="TreeWalker">
 

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/sdks/java/build-tools/src/main/resources/beam/suppressions.xml
----------------------------------------------------------------------
diff --git a/sdks/java/build-tools/src/main/resources/beam/suppressions.xml b/sdks/java/build-tools/src/main/resources/beam/suppressions.xml
new file mode 100644
index 0000000..6dbb7f5
--- /dev/null
+++ b/sdks/java/build-tools/src/main/resources/beam/suppressions.xml
@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<!--
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License. See accompanying LICENSE file.
+-->
+<!DOCTYPE suppressions PUBLIC
+"-//Puppy Crawl//DTD Suppressions 1.1//EN"
+"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
+
+<suppressions>
+  <suppress checks="JavadocPackage" files=".*/src/test/.*"/>
+  <suppress checks="JavadocPackage" files=".*/maven-archetypes/.*"/>
+  <suppress checks="JavadocPackage" files=".*/examples/.*"/>
+</suppressions>
+

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/sdks/java/core/src/main/java/org/apache/beam/sdk/util/common/package-info.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/common/package-info.java
b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/common/package-info.java
index 13b94e9..1ea8af8 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/common/package-info.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/common/package-info.java
@@ -15,5 +15,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/** Defines utilities shared by multiple PipelineRunner implementations. **/
+
+/** Defines utilities shared by multiple PipelineRunner implementations. */
 package org.apache.beam.sdk.util.common;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/sdks/java/core/src/main/java/org/apache/beam/sdk/util/gcsfs/package-info.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/gcsfs/package-info.java
b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/gcsfs/package-info.java
index c7e09ec..4d49f8c 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/gcsfs/package-info.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/gcsfs/package-info.java
@@ -15,5 +15,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/** Defines utilities used to interact with Google Cloud Storage. **/
+
+/** Defines utilities used to interact with Google Cloud Storage. */
 package org.apache.beam.sdk.util.gcsfs;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/sdks/java/core/src/main/java/org/apache/beam/sdk/util/package-info.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/package-info.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/package-info.java
index aab0399..b4772f3 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/package-info.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/package-info.java
@@ -15,5 +15,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/** Defines utilities used by the Dataflow SDK. **/
+
+/** Defines utilities that can be used by Beam runners. */
 package org.apache.beam.sdk.util;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/package-info.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/package-info.java
b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/package-info.java
new file mode 100644
index 0000000..b9bec16
--- /dev/null
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Defines internal utilities for interacting with pipeline state.
+ */
+package org.apache.beam.sdk.util.state;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/sdks/java/extensions/join-library/src/main/java/org/apache/beam/sdk/extensions/joinlibrary/package-info.java
----------------------------------------------------------------------
diff --git a/sdks/java/extensions/join-library/src/main/java/org/apache/beam/sdk/extensions/joinlibrary/package-info.java
b/sdks/java/extensions/join-library/src/main/java/org/apache/beam/sdk/extensions/joinlibrary/package-info.java
new file mode 100644
index 0000000..cc5b9f5
--- /dev/null
+++ b/sdks/java/extensions/join-library/src/main/java/org/apache/beam/sdk/extensions/joinlibrary/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Utilities for performing SQL-style joins of keyed {@link org.apache.beam.sdk.values.PCollection
+ * PCollections}.
+ */
+package org.apache.beam.sdk.extensions.joinlibrary;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/sdks/java/io/hdfs/src/main/java/org/apache/beam/sdk/io/hdfs/package-info.java
----------------------------------------------------------------------
diff --git a/sdks/java/io/hdfs/src/main/java/org/apache/beam/sdk/io/hdfs/package-info.java
b/sdks/java/io/hdfs/src/main/java/org/apache/beam/sdk/io/hdfs/package-info.java
new file mode 100644
index 0000000..763b30a
--- /dev/null
+++ b/sdks/java/io/hdfs/src/main/java/org/apache/beam/sdk/io/hdfs/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Transforms used to read from the Hadoop file system (HDFS).
+ */
+package org.apache.beam.sdk.io.hdfs;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/sdks/java/io/hdfs/src/main/java/org/apache/beam/sdk/io/hdfs/simpleauth/package-info.java
----------------------------------------------------------------------
diff --git a/sdks/java/io/hdfs/src/main/java/org/apache/beam/sdk/io/hdfs/simpleauth/package-info.java
b/sdks/java/io/hdfs/src/main/java/org/apache/beam/sdk/io/hdfs/simpleauth/package-info.java
new file mode 100644
index 0000000..201f227
--- /dev/null
+++ b/sdks/java/io/hdfs/src/main/java/org/apache/beam/sdk/io/hdfs/simpleauth/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Transforms used to read from the Hadoop file system (HDFS) with authentication.
+ */
+package org.apache.beam.sdk.io.hdfs.simpleauth;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/package-info.java
----------------------------------------------------------------------
diff --git a/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/package-info.java
b/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/package-info.java
new file mode 100644
index 0000000..2b82ff9
--- /dev/null
+++ b/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Transforms for reading and writing from Apache Kafka.
+ */
+package org.apache.beam.sdk.io.kafka;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/sdks/java/microbenchmarks/src/main/java/org/apache/beam/sdk/microbenchmarks/coders/package-info.java
----------------------------------------------------------------------
diff --git a/sdks/java/microbenchmarks/src/main/java/org/apache/beam/sdk/microbenchmarks/coders/package-info.java
b/sdks/java/microbenchmarks/src/main/java/org/apache/beam/sdk/microbenchmarks/coders/package-info.java
new file mode 100644
index 0000000..0d735ee
--- /dev/null
+++ b/sdks/java/microbenchmarks/src/main/java/org/apache/beam/sdk/microbenchmarks/coders/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Benchmarks of various {@code Coder} implementations.
+ */
+package org.apache.beam.sdk.microbenchmarks.coders;

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/ad6ee018/sdks/java/microbenchmarks/src/main/java/org/apache/beam/sdk/microbenchmarks/transforms/package-info.java
----------------------------------------------------------------------
diff --git a/sdks/java/microbenchmarks/src/main/java/org/apache/beam/sdk/microbenchmarks/transforms/package-info.java
b/sdks/java/microbenchmarks/src/main/java/org/apache/beam/sdk/microbenchmarks/transforms/package-info.java
new file mode 100644
index 0000000..b91e7b2
--- /dev/null
+++ b/sdks/java/microbenchmarks/src/main/java/org/apache/beam/sdk/microbenchmarks/transforms/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Provides microbenchmarks of various transforms.
+ */
+package org.apache.beam.sdk.microbenchmarks.transforms;



Mime
View raw message