[FLINK-6675] Activate strict checkstyle for flink-annotations This closes #3970.
Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/dbcc456a Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/dbcc456a Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/dbcc456a Branch: refs/heads/master Commit: dbcc456a652e980323b1b23692578e3c22e25e68 Parents: 04fae53 Author: zentol <[email protected]> Authored: Tue May 23 13:47:53 2017 +0200 Committer: zentol <[email protected]> Committed: Wed May 24 16:46:03 2017 +0200 ---------------------------------------------------------------------- flink-annotations/pom.xml | 38 ++++++++++++++++++++ .../org/apache/flink/annotation/Internal.java | 1 + .../org/apache/flink/annotation/Public.java | 1 + .../apache/flink/annotation/PublicEvolving.java | 1 + .../flink/annotation/VisibleForTesting.java | 3 +- 5 files changed, 43 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/dbcc456a/flink-annotations/pom.xml ---------------------------------------------------------------------- diff --git a/flink-annotations/pom.xml b/flink-annotations/pom.xml index b375611..08e10f5 100644 --- a/flink-annotations/pom.xml +++ b/flink-annotations/pom.xml @@ -34,4 +34,42 @@ under the License. <packaging>jar</packaging> + <build> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.17</version> + <dependencies> + <dependency> + <groupId>com.puppycrawl.tools</groupId> + <artifactId>checkstyle</artifactId> + <version>6.19</version> + </dependency> + </dependencies> + <configuration> + <configLocation>/tools/maven/strict-checkstyle.xml</configLocation> + <suppressionsLocation>/tools/maven/suppressions.xml</suppressionsLocation> + <includeTestSourceDirectory>true</includeTestSourceDirectory> + <logViolationsToConsole>true</logViolationsToConsole> + <failOnViolation>true</failOnViolation> + </configuration> + <executions> + <!-- + Execute checkstyle after compilation but before tests. + This ensures that any parsing or type checking errors are from + javac, so they look as expected. Beyond that, we want to + fail as early as possible. + --> + <execution> + <phase>test-compile</phase> + <goals> + <goal>check</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> + </build> + </project> http://git-wip-us.apache.org/repos/asf/flink/blob/dbcc456a/flink-annotations/src/main/java/org/apache/flink/annotation/Internal.java ---------------------------------------------------------------------- diff --git a/flink-annotations/src/main/java/org/apache/flink/annotation/Internal.java b/flink-annotations/src/main/java/org/apache/flink/annotation/Internal.java index dd9f080..65231c2 100644 --- a/flink-annotations/src/main/java/org/apache/flink/annotation/Internal.java +++ b/flink-annotations/src/main/java/org/apache/flink/annotation/Internal.java @@ -16,6 +16,7 @@ * limitations under the License. * */ + package org.apache.flink.annotation; import java.lang.annotation.Documented; http://git-wip-us.apache.org/repos/asf/flink/blob/dbcc456a/flink-annotations/src/main/java/org/apache/flink/annotation/Public.java ---------------------------------------------------------------------- diff --git a/flink-annotations/src/main/java/org/apache/flink/annotation/Public.java b/flink-annotations/src/main/java/org/apache/flink/annotation/Public.java index d891a0a..1e3bd09 100644 --- a/flink-annotations/src/main/java/org/apache/flink/annotation/Public.java +++ b/flink-annotations/src/main/java/org/apache/flink/annotation/Public.java @@ -16,6 +16,7 @@ * limitations under the License. * */ + package org.apache.flink.annotation; import java.lang.annotation.Documented; http://git-wip-us.apache.org/repos/asf/flink/blob/dbcc456a/flink-annotations/src/main/java/org/apache/flink/annotation/PublicEvolving.java ---------------------------------------------------------------------- diff --git a/flink-annotations/src/main/java/org/apache/flink/annotation/PublicEvolving.java b/flink-annotations/src/main/java/org/apache/flink/annotation/PublicEvolving.java index 0c093a2..3389e71 100644 --- a/flink-annotations/src/main/java/org/apache/flink/annotation/PublicEvolving.java +++ b/flink-annotations/src/main/java/org/apache/flink/annotation/PublicEvolving.java @@ -16,6 +16,7 @@ * limitations under the License. * */ + package org.apache.flink.annotation; import java.lang.annotation.Documented; http://git-wip-us.apache.org/repos/asf/flink/blob/dbcc456a/flink-annotations/src/main/java/org/apache/flink/annotation/VisibleForTesting.java ---------------------------------------------------------------------- diff --git a/flink-annotations/src/main/java/org/apache/flink/annotation/VisibleForTesting.java b/flink-annotations/src/main/java/org/apache/flink/annotation/VisibleForTesting.java index 8f945a9..bed7db0 100644 --- a/flink-annotations/src/main/java/org/apache/flink/annotation/VisibleForTesting.java +++ b/flink-annotations/src/main/java/org/apache/flink/annotation/VisibleForTesting.java @@ -16,6 +16,7 @@ * limitations under the License. * */ + package org.apache.flink.annotation; import java.lang.annotation.Documented; @@ -25,7 +26,7 @@ import java.lang.annotation.Target; /** * This annotations declares that a function, field, constructor, or entire type, is only visible for * testing purposes. - * + * * <p>This annotation is typically attached when for example a method should be {@code private} * (because it is not intended to be called externally), but cannot be declared private, because * some tests need to have access to it.
