flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From se...@apache.org
Subject flink git commit: [FLINK-4431] [core] Introduce a "VisibleForTesting" annotation.
Date Fri, 19 Aug 2016 21:59:14 GMT
Repository: flink
Updated Branches:
  refs/heads/master 7e8de772b -> 59eb4332f


[FLINK-4431] [core] Introduce a "VisibleForTesting" annotation.

This annotation documents methods/fields that are not private because tests need them,
but should not be called by any non-testing code.

This closes #2390


Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/59eb4332
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/59eb4332
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/59eb4332

Branch: refs/heads/master
Commit: 59eb4332f31204b118fe95d56bcf3893ae705866
Parents: 7e8de77
Author: Stephan Ewen <sewen@apache.org>
Authored: Fri Aug 19 12:16:09 2016 +0200
Committer: Stephan Ewen <sewen@apache.org>
Committed: Fri Aug 19 23:52:45 2016 +0200

----------------------------------------------------------------------
 .../flink/annotation/VisibleForTesting.java     | 36 ++++++++++++++++++++
 1 file changed, 36 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/59eb4332/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
new file mode 100644
index 0000000..8f945a9
--- /dev/null
+++ b/flink-annotations/src/main/java/org/apache/flink/annotation/VisibleForTesting.java
@@ -0,0 +1,36 @@
+/*
+ * 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.
+ *
+ */
+package org.apache.flink.annotation;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+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.
+ */
+@Documented
+@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD, ElementType.CONSTRUCTOR
})
+@Internal
+public @interface VisibleForTesting {}


Mime
View raw message