flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ches...@apache.org
Subject flink git commit: [hotfix][javadocs] Clarify replacement for deprecated FoldingState
Date Wed, 13 Dec 2017 10:21:50 GMT
Repository: flink
Updated Branches:
  refs/heads/master 402af2a07 -> 01d0d256d


[hotfix][javadocs] Clarify replacement for deprecated FoldingState

This closes #5129.


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

Branch: refs/heads/master
Commit: 01d0d256d633108177ddc77288287e1201e31de0
Parents: 402af2a
Author: Bowen Li <bowenli86@gmail.com>
Authored: Wed Dec 6 11:37:54 2017 -0800
Committer: zentol <chesnay@apache.org>
Committed: Wed Dec 13 11:21:01 2017 +0100

----------------------------------------------------------------------
 docs/dev/stream/state/state.md                                     | 2 +-
 .../java/org/apache/flink/api/common/functions/RuntimeContext.java | 2 +-
 .../main/java/org/apache/flink/api/common/state/FoldingState.java  | 2 +-
 .../java/org/apache/flink/api/common/state/KeyedStateStore.java    | 2 +-
 .../main/java/org/apache/flink/api/common/state/StateBinder.java   | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/01d0d256/docs/dev/stream/state/state.md
----------------------------------------------------------------------
diff --git a/docs/dev/stream/state/state.md b/docs/dev/stream/state/state.md
index c9a68ab..e9770bd 100644
--- a/docs/dev/stream/state/state.md
+++ b/docs/dev/stream/state/state.md
@@ -119,7 +119,7 @@ views for mappings, keys and values can be retrieved using `entries()`,
`keys()`
 All types of state also have a method `clear()` that clears the state for the currently
 active key, i.e. the key of the input element.
 
-<span class="label label-danger">Attention</span> `FoldingState` and `FoldingStateDescriptor`
have been deprecated in Flink 1.4 and will be completely removed in the future. A more general
alternative will be provided.
+<span class="label label-danger">Attention</span> `FoldingState` and `FoldingStateDescriptor`
have been deprecated in Flink 1.4 and will be completely removed in the future. Please use
`AggregatingState` and `AggregatingStateDescriptor` instead.
 
 It is important to keep in mind that these state objects are only used for interfacing
 with state. The state is not necessarily stored inside but might reside on disk or somewhere
else.

http://git-wip-us.apache.org/repos/asf/flink/blob/01d0d256/flink-core/src/main/java/org/apache/flink/api/common/functions/RuntimeContext.java
----------------------------------------------------------------------
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/functions/RuntimeContext.java
b/flink-core/src/main/java/org/apache/flink/api/common/functions/RuntimeContext.java
index 7a89e10..3429143 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/functions/RuntimeContext.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/functions/RuntimeContext.java
@@ -441,7 +441,7 @@ public interface RuntimeContext {
 	 * @throws UnsupportedOperationException Thrown, if no partitioned state is available for
the
 	 *                                       function (function is not part of a KeyedStream).
 	 *
-	 * @deprecated will be removed in a future version
+	 * @deprecated will be removed in a future version in favor of {@link AggregatingState}
 	 */
 	@PublicEvolving
 	@Deprecated

http://git-wip-us.apache.org/repos/asf/flink/blob/01d0d256/flink-core/src/main/java/org/apache/flink/api/common/state/FoldingState.java
----------------------------------------------------------------------
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/state/FoldingState.java
b/flink-core/src/main/java/org/apache/flink/api/common/state/FoldingState.java
index b47a1a1..df9a0c6 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/state/FoldingState.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/state/FoldingState.java
@@ -36,7 +36,7 @@ import org.apache.flink.annotation.PublicEvolving;
  * @param <T> Type of the values folded into the state
  * @param <ACC> Type of the value in the state
  *
- * @deprecated will be removed in a future version
+ * @deprecated will be removed in a future version in favor of {@link AggregatingState}
  */
 @PublicEvolving
 @Deprecated

http://git-wip-us.apache.org/repos/asf/flink/blob/01d0d256/flink-core/src/main/java/org/apache/flink/api/common/state/KeyedStateStore.java
----------------------------------------------------------------------
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/state/KeyedStateStore.java
b/flink-core/src/main/java/org/apache/flink/api/common/state/KeyedStateStore.java
index 7f45214..a1038a8 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/state/KeyedStateStore.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/state/KeyedStateStore.java
@@ -237,7 +237,7 @@ public interface KeyedStateStore {
 	 * @throws UnsupportedOperationException Thrown, if no partitioned state is available for
the
 	 *                                       function (function is not part of a KeyedStream).
 	 *
-	 * @deprecated will be removed in a future version
+	 * @deprecated will be removed in a future version in favor of {@link AggregatingState}
 	 */
 	@PublicEvolving
 	@Deprecated

http://git-wip-us.apache.org/repos/asf/flink/blob/01d0d256/flink-core/src/main/java/org/apache/flink/api/common/state/StateBinder.java
----------------------------------------------------------------------
diff --git a/flink-core/src/main/java/org/apache/flink/api/common/state/StateBinder.java b/flink-core/src/main/java/org/apache/flink/api/common/state/StateBinder.java
index a373923..a1f7d8d 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/state/StateBinder.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/state/StateBinder.java
@@ -69,7 +69,7 @@ public interface StateBinder {
 	 * @param <T> Type of the values folded into the state
 	 * @param <ACC> Type of the value in the state
 	 *
-	 * @deprecated will be removed in a future version
+	 * @deprecated will be removed in a future version in favor of {@link AggregatingState}
 	 */
 	@Deprecated
 	<T, ACC> FoldingState<T, ACC> createFoldingState(FoldingStateDescriptor<T,
ACC> stateDesc) throws Exception;


Mime
View raw message