You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by tz...@apache.org on 2020/02/06 03:02:42 UTC
[flink-statefun] branch master updated (1cdd50b -> 9103db9)
This is an automated email from the ASF dual-hosted git repository.
tzulitai pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/flink-statefun.git.
from 1cdd50b [hotfix] [doc] Documentation build README mentions incorrect generated PDF name
add a250cd8 [FLINK-15899] [build] Inherit from Apache Parent POM
new 4ada151 [FLINK-15899] [build] Fix Javadocs to comply with Maven Javadoc Plugin
new 08e3fdf [FLINK-15910] [legal] Add NOTICE file to root dir for source distribution
new 9103db9 [FLINK-15910] [legal] Add NOTICE and LICENSE files to statefun-flink-distribution
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
NOTICE | 10 +++++++
pom.xml | 25 +++++++++++++++++
statefun-examples/statefun-greeter-example/pom.xml | 7 +++++
.../statefun/examples/greeter/GreetingModule.java | 2 +-
.../java/it/unimi/dsi/fastutil/HashCommon.java | 10 ++++++-
.../dsi/fastutil/objects/ObjectOpenHashMap.java | 7 ++++-
statefun-flink/statefun-flink-distribution/pom.xml | 5 ++++
.../src/main/resources/META-INF/NOTICE | 25 +++++++++++++++++
.../main/resources/META-INF/licenses/LICENSE.kryo | 10 +++++++
.../resources/META-INF/licenses/LICENSE.minlog | 10 +++++++
.../META-INF/licenses/LICENSE.protobuf-java | 32 ++++++++++++++++++++++
.../resources/META-INF/licenses/LICENSE.zstd-jni | 26 ++++++++++++++++++
.../processor/BootstrapDataRouterProvider.java | 6 +++-
.../state/processor/StateBootstrapFunction.java | 4 +--
.../StatefulFunctionsSavepointCreator.java | 6 ++++
.../operator/StateBootstrapFunctionRegistry.java | 6 +++-
.../org/apache/flink/statefun/sdk/Context.java | 6 ++--
.../flink/statefun/sdk/StatefulFunction.java | 4 +--
.../flink/statefun/sdk/match/MatchBinder.java | 3 ++
.../statefun/sdk/spi/StatefulFunctionModule.java | 4 +--
20 files changed, 195 insertions(+), 13 deletions(-)
create mode 100644 NOTICE
create mode 100644 statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/NOTICE
create mode 100644 statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.kryo
create mode 100644 statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.minlog
create mode 100644 statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.protobuf-java
create mode 100644 statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.zstd-jni
[flink-statefun] 03/03: [FLINK-15910] [legal] Add NOTICE and
LICENSE files to statefun-flink-distribution
Posted by tz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tzulitai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-statefun.git
commit 9103db919c3f24f5531d31762d6472c622d835e6
Author: Tzu-Li (Gordon) Tai <tz...@apache.org>
AuthorDate: Wed Feb 5 16:53:09 2020 +0800
[FLINK-15910] [legal] Add NOTICE and LICENSE files to statefun-flink-distribution
Adds explicit NOTICE and LICENSE files to be bundled in the jar, since
statefun-flink-distribution builds a fat jar with dependencies bundled.
This closes #13.
---
pom.xml | 2 ++
statefun-flink/statefun-flink-distribution/pom.xml | 5 ++++
.../src/main/resources/META-INF/NOTICE | 25 +++++++++++++++++
.../main/resources/META-INF/licenses/LICENSE.kryo | 10 +++++++
.../resources/META-INF/licenses/LICENSE.minlog | 10 +++++++
.../META-INF/licenses/LICENSE.protobuf-java | 32 ++++++++++++++++++++++
.../resources/META-INF/licenses/LICENSE.zstd-jni | 26 ++++++++++++++++++
7 files changed, 110 insertions(+)
diff --git a/pom.xml b/pom.xml
index d9022c5..f5f33f1 100644
--- a/pom.xml
+++ b/pom.xml
@@ -210,6 +210,8 @@ under the License.
<exclude>statefun-docs/docs/_templates/**</exclude>
<!-- Generated code -->
<exclude>**/generated/**</exclude>
+ <!-- Bundled license files -->
+ <exclude>**/LICENSE*</exclude>
</excludes>
</configuration>
</plugin>
diff --git a/statefun-flink/statefun-flink-distribution/pom.xml b/statefun-flink/statefun-flink-distribution/pom.xml
index b658fc5..ea125fa 100644
--- a/statefun-flink/statefun-flink-distribution/pom.xml
+++ b/statefun-flink/statefun-flink-distribution/pom.xml
@@ -136,6 +136,11 @@ under the License.
<!-- required to aggregate all the META-INF/services files -->
<transformer
implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
+ <transformer
+ implementation="org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer">
+ <projectName>Apache Flink Stateful Functions (flink-statefun)</projectName>
+ <encoding>UTF-8</encoding>
+ </transformer>
</transformers>
</configuration>
</execution>
diff --git a/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/NOTICE b/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/NOTICE
new file mode 100644
index 0000000..d795bb7
--- /dev/null
+++ b/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/NOTICE
@@ -0,0 +1,25 @@
+statefun-flink-distribution
+Copyright 2014-2020 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
+This project bundles the following dependencies under the Apache Software License 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt)
+
+- commons-collections:commons-collections:3.2.2
+- commons-cli:commons-cli:jar:1.3.1
+- com.google.auto.service:auto-service-annotations:1.0-rc6
+- org.apache.commons:commons-compress:1.18
+- org.apache.commons:commons-math3:3.5
+- org.apache.commons:commons-lang3:3.3.2
+- org.apache.kafka:kafka-clients:2.2.0
+- org.lz4:lz4-java:1.5.0
+- org.objenesis:objenesis:2.1
+
+This project bundles the following dependencies under the BSD license.
+See bundled license files under "META-INF/licenses" for details.
+
+- com.esotericsoftware.kryo:kryo:2.24.0
+- com.esotericsoftware.minlog:minlog:1.2
+- com.github.luben:zstd-jni:1.3.8-1
+- com.google.protobuf:protobuf-java:3.8.0
\ No newline at end of file
diff --git a/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.kryo b/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.kryo
new file mode 100644
index 0000000..c988005
--- /dev/null
+++ b/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.kryo
@@ -0,0 +1,10 @@
+Copyright (c) 2008-2018, Nathan Sweet
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of Esoteric Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROF [...]
\ No newline at end of file
diff --git a/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.minlog b/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.minlog
new file mode 100644
index 0000000..3f6a160
--- /dev/null
+++ b/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.minlog
@@ -0,0 +1,10 @@
+Copyright (c) 2008, Nathan Sweet
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+ * Neither the name of Esoteric Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROF [...]
\ No newline at end of file
diff --git a/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.protobuf-java b/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.protobuf-java
new file mode 100644
index 0000000..97a6e3d
--- /dev/null
+++ b/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.protobuf-java
@@ -0,0 +1,32 @@
+Copyright 2008 Google Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+ * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+ * Neither the name of Google Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Code generated by the Protocol Buffer compiler is owned by the owner
+of the input file used when generating it. This code is not
+standalone and requires a support library to be linked with it. This
+support library is itself covered by the above license.
\ No newline at end of file
diff --git a/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.zstd-jni b/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.zstd-jni
new file mode 100644
index 0000000..7bdccb6
--- /dev/null
+++ b/statefun-flink/statefun-flink-distribution/src/main/resources/META-INF/licenses/LICENSE.zstd-jni
@@ -0,0 +1,26 @@
+Zstd-jni: JNI bindings to Zstd Library
+
+Copyright (c) 2015-present, Luben Karavelov/ All rights reserved.
+
+BSD License
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+ list of conditions and the following disclaimer in the documentation and/or
+ other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
[flink-statefun] 02/03: [FLINK-15910] [legal] Add NOTICE file to
root dir for source distribution
Posted by tz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tzulitai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-statefun.git
commit 08e3fdff53edd3a54f6c27e3dd5067b194b499c7
Author: Tzu-Li (Gordon) Tai <tz...@apache.org>
AuthorDate: Wed Feb 5 16:52:17 2020 +0800
[FLINK-15910] [legal] Add NOTICE file to root dir for source distribution
---
NOTICE | 10 ++++++++++
.../src/main/java/it/unimi/dsi/fastutil/HashCommon.java | 10 +++++++++-
.../java/it/unimi/dsi/fastutil/objects/ObjectOpenHashMap.java | 7 ++++++-
3 files changed, 25 insertions(+), 2 deletions(-)
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..9299541
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,10 @@
+Apache Flink Stateful Functions (flink-statefun)
+Copyright 2014-2020 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
+This project contains copied and modified source code that is licensed under the Apache Software License 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt) from the following projects:
+
+- fastutil (http://fastutil.di.unimi.it/) Copyright (c) - Sebastiano Vigna
+ The copied sources can be located under statefun-flink/statefun-flink-core/src/main/java/it/unimi/dsi/fastutil/
diff --git a/statefun-flink/statefun-flink-core/src/main/java/it/unimi/dsi/fastutil/HashCommon.java b/statefun-flink/statefun-flink-core/src/main/java/it/unimi/dsi/fastutil/HashCommon.java
index b81017a..6c457e7 100644
--- a/statefun-flink/statefun-flink-core/src/main/java/it/unimi/dsi/fastutil/HashCommon.java
+++ b/statefun-flink/statefun-flink-core/src/main/java/it/unimi/dsi/fastutil/HashCommon.java
@@ -15,7 +15,15 @@
*/
package it.unimi.dsi.fastutil;
-/** Common code for all hash-based classes. */
+/**
+ * NOTE: This source code was copied from the <a href="http://fastutil.di.unimi.it/">fastutil</a>
+ * project, and has been modified.
+ *
+ * <p>Common code for all hash-based classes.
+ *
+ * @author Sebastiano Vigna
+ * @see <a href="http://fastutil.di.unimi.it/">fastutil</a>
+ */
public class HashCommon {
/** 2<sup>32</sup> · φ, φ = (√5 − 1)/2. */
diff --git a/statefun-flink/statefun-flink-core/src/main/java/it/unimi/dsi/fastutil/objects/ObjectOpenHashMap.java b/statefun-flink/statefun-flink-core/src/main/java/it/unimi/dsi/fastutil/objects/ObjectOpenHashMap.java
index 6cdb26a..6fa5670 100644
--- a/statefun-flink/statefun-flink-core/src/main/java/it/unimi/dsi/fastutil/objects/ObjectOpenHashMap.java
+++ b/statefun-flink/statefun-flink-core/src/main/java/it/unimi/dsi/fastutil/objects/ObjectOpenHashMap.java
@@ -22,7 +22,10 @@ import it.unimi.dsi.fastutil.HashCommon;
import java.util.Arrays;
/**
- * A type-specific hash map with a fast, small-footprint implementation.
+ * NOTE: This source code was copied from the <a href="http://fastutil.di.unimi.it/">fastutil</a>
+ * project, and has been modified.
+ *
+ * <p>A type-specific hash map with a fast, small-footprint implementation.
*
* <p>Instances of this class use a hash table to represent a map. The table is filled up to a
* specified <em>load factor</em>, and then doubled in size to accommodate new entries. If the table
@@ -32,7 +35,9 @@ import java.util.Arrays;
* rehashing. Moreover, halving is not performed when deleting entries from an iterator, as it would
* interfere with the iteration process.
*
+ * @author Sebastiano Vigna
* @see HashCommon
+ * @see <a href="http://fastutil.di.unimi.it/">fastutil</a>
*/
public final class ObjectOpenHashMap<K, V> {
[flink-statefun] 01/03: [FLINK-15899] [build] Fix Javadocs to
comply with Maven Javadoc Plugin
Posted by tz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tzulitai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-statefun.git
commit 4ada15123a7ad4c49e7d18fcf4b49192c5650eeb
Author: Tzu-Li (Gordon) Tai <tz...@apache.org>
AuthorDate: Wed Feb 5 14:12:03 2020 +0800
[FLINK-15899] [build] Fix Javadocs to comply with Maven Javadoc Plugin
This closes #12.
---
statefun-examples/statefun-greeter-example/pom.xml | 7 +++++++
.../org/apache/flink/statefun/examples/greeter/GreetingModule.java | 2 +-
.../flink/state/processor/BootstrapDataRouterProvider.java | 6 +++++-
.../statefun/flink/state/processor/StateBootstrapFunction.java | 4 ++--
.../flink/state/processor/StatefulFunctionsSavepointCreator.java | 6 ++++++
.../state/processor/operator/StateBootstrapFunctionRegistry.java | 6 +++++-
.../src/main/java/org/apache/flink/statefun/sdk/Context.java | 6 ++++--
.../main/java/org/apache/flink/statefun/sdk/StatefulFunction.java | 4 ++--
.../main/java/org/apache/flink/statefun/sdk/match/MatchBinder.java | 3 +++
.../org/apache/flink/statefun/sdk/spi/StatefulFunctionModule.java | 4 ++--
10 files changed, 37 insertions(+), 11 deletions(-)
diff --git a/statefun-examples/statefun-greeter-example/pom.xml b/statefun-examples/statefun-greeter-example/pom.xml
index f10b6c5..455efc0 100644
--- a/statefun-examples/statefun-greeter-example/pom.xml
+++ b/statefun-examples/statefun-greeter-example/pom.xml
@@ -53,6 +53,13 @@ under the License.
<artifactId>protoc-jar-maven-plugin</artifactId>
<version>${protoc-jar-maven-plugin.version}</version>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <excludePackageNames>org.apache.flink.statefun.examples.greeter.generated</excludePackageNames>
+ </configuration>
+ </plugin>
</plugins>
</build>
diff --git a/statefun-examples/statefun-greeter-example/src/main/java/org/apache/flink/statefun/examples/greeter/GreetingModule.java b/statefun-examples/statefun-greeter-example/src/main/java/org/apache/flink/statefun/examples/greeter/GreetingModule.java
index 829d8fe..79c008c 100644
--- a/statefun-examples/statefun-greeter-example/src/main/java/org/apache/flink/statefun/examples/greeter/GreetingModule.java
+++ b/statefun-examples/statefun-greeter-example/src/main/java/org/apache/flink/statefun/examples/greeter/GreetingModule.java
@@ -25,7 +25,7 @@ import org.apache.flink.statefun.sdk.spi.StatefulFunctionModule;
* The top level entry point for this application.
*
* <p>On deployment, the address of the Kafka brokers can be configured by passing the flag
- * `--kafka-address <address>`. If no flag is passed, then the default address will be used.
+ * `--kafka-address <address>`. If no flag is passed, then the default address will be used.
*/
@AutoService(StatefulFunctionModule.class)
public final class GreetingModule implements StatefulFunctionModule {
diff --git a/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/BootstrapDataRouterProvider.java b/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/BootstrapDataRouterProvider.java
index 4df13c4..13f3c8d 100644
--- a/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/BootstrapDataRouterProvider.java
+++ b/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/BootstrapDataRouterProvider.java
@@ -29,7 +29,11 @@ import org.apache.flink.statefun.sdk.io.Router;
*/
public interface BootstrapDataRouterProvider<T> extends Serializable {
- /** Creates a {@link Router} instance. */
+ /**
+ * Creates a {@link Router} instance.
+ *
+ * @return a router for bootstrap data
+ */
@Nonnull
Router<T> provide();
}
diff --git a/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/StateBootstrapFunction.java b/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/StateBootstrapFunction.java
index 36057c5..6318a9c 100644
--- a/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/StateBootstrapFunction.java
+++ b/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/StateBootstrapFunction.java
@@ -35,10 +35,10 @@ import org.apache.flink.statefun.sdk.StatefulFunction;
* <pre>{@code
* public class MyStateBootstrapFunction implements StateBootstrapFunction {
*
- * @Persisted
+ * {@code @Persisted}
* private PersistedValue<MyState> state = PersistedValue.of("my-state", MyState.class);
*
- * @Override
+ * {@code @Override}
* public void bootstrap(Context context, Object input) {
* state.set(extractStateFromInput(input));
* }
diff --git a/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/StatefulFunctionsSavepointCreator.java b/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/StatefulFunctionsSavepointCreator.java
index 8a40d4b..cb69d10 100644
--- a/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/StatefulFunctionsSavepointCreator.java
+++ b/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/StatefulFunctionsSavepointCreator.java
@@ -86,6 +86,7 @@ public class StatefulFunctionsSavepointCreator {
* is configured by the Stateful Functions application to be restored using the generated
* savepoint.
*
+ * @return the savepoint creator, with state multiplexing disabled
* @see StatefulFunctionsJobConstants#MULTIPLEX_FLINK_STATE
*/
public StatefulFunctionsSavepointCreator disableMultiplexState() {
@@ -100,6 +101,8 @@ public class StatefulFunctionsSavepointCreator {
* <p>This affects the format of the generated savepoint, and should therefore be the same as what
* is configured by the Stateful Functions application to be restored using the generated
* savepoint.
+ *
+ * @return the savepoint creator, configured to use the {@link FsStateBackend}.
*/
public StatefulFunctionsSavepointCreator withFsStateBackend() {
this.stateBackend = new FsStateBackend("file:///tmp/ignored");
@@ -119,6 +122,7 @@ public class StatefulFunctionsSavepointCreator {
* @param routerProvider provider of a {@link Router} that addresses each element in the bootstrap
* dataset to {@link StateBootstrapFunction} instances.
* @param <IN> data type of the input bootstrap dataset
+ * @return the savepoint creator, configured to use the given bootstrap data
*/
public <IN> StatefulFunctionsSavepointCreator withBootstrapData(
DataSet<IN> bootstrapDataset, BootstrapDataRouterProvider<IN> routerProvider) {
@@ -131,6 +135,8 @@ public class StatefulFunctionsSavepointCreator {
*
* @param functionType the type of function that is being bootstrapped.
* @param bootstrapFunctionProvider the bootstrap function provider to register.
+ * @return the savepoint creator, configured to use the given {@link
+ * StateBootstrapFunctionProvider}.
*/
public StatefulFunctionsSavepointCreator withStateBootstrapFunctionProvider(
FunctionType functionType, StateBootstrapFunctionProvider bootstrapFunctionProvider) {
diff --git a/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/operator/StateBootstrapFunctionRegistry.java b/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/operator/StateBootstrapFunctionRegistry.java
index 71409c9..0b84c0b 100644
--- a/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/operator/StateBootstrapFunctionRegistry.java
+++ b/statefun-flink/statefun-flink-state-processor/src/main/java/org/apache/flink/statefun/flink/state/processor/operator/StateBootstrapFunctionRegistry.java
@@ -74,7 +74,11 @@ public final class StateBootstrapFunctionRegistry implements Serializable {
functionType));
}
- /** Returns number of registrations. */
+ /**
+ * Returns number of registrations.
+ *
+ * @return number of registrations.
+ */
public int numRegistrations() {
return stateBootstrapFunctionProviders.size();
}
diff --git a/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/Context.java b/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/Context.java
index 690ba8e..d3a1231 100644
--- a/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/Context.java
+++ b/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/Context.java
@@ -67,7 +67,8 @@ public interface Context {
* Invokes another function with an input, identified by the target function's {@link Address},
* after a given delay.
*
- * @param delay the amount of delay before invoking the target function. Value needs to be >= 0.
+ * @param delay the amount of delay before invoking the target function. Value needs to be >=
+ * 0.
* @param to the target function's address.
* @param message the input to provide for the delayed invocation.
*/
@@ -89,7 +90,8 @@ public interface Context {
* Invokes another function with an input, identified by the target function's {@link
* FunctionType} and unique id.
*
- * @param delay the amount of delay before invoking the target function. Value needs to be >= 0.
+ * @param delay the amount of delay before invoking the target function. Value needs to be >=
+ * 0.
* @param functionType the target function's type.
* @param id the target function's id within its type.
* @param message the input to provide for the delayed invocation.
diff --git a/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/StatefulFunction.java b/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/StatefulFunction.java
index ee1c52f..7fd1c0f 100644
--- a/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/StatefulFunction.java
+++ b/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/StatefulFunction.java
@@ -54,10 +54,10 @@ import org.apache.flink.statefun.sdk.state.PersistedValue;
* <pre>{@code
* public class MyFunction implements StatefulFunction {
*
- * @Persisted
+ * {@code @Persisted}
* PersistedValue<Integer> intState = PersistedValue.of("state-name", Integer.class);
*
- * @Override
+ * {@code @Override}
* public void invoke(Context context, Object input) {
* Integer stateValue = intState.get();
* //...
diff --git a/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/match/MatchBinder.java b/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/match/MatchBinder.java
index 1f539f2..0d3413f 100644
--- a/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/match/MatchBinder.java
+++ b/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/match/MatchBinder.java
@@ -65,6 +65,7 @@ public final class MatchBinder {
* @param type the expected input type.
* @param action the action to take if this pattern matches.
* @param <T> the expected input type.
+ * @return the binder, with predicate bound
*/
@SuppressWarnings("unchecked")
public <T> MatchBinder predicate(Class<T> type, BiConsumer<Context, T> action) {
@@ -91,6 +92,7 @@ public final class MatchBinder {
* @param predicate a predicate on the input object state to match on.
* @param action the action to take if this patten matches.
* @param <T> the expected input type.
+ * @return the binder, with predicate bound
*/
@SuppressWarnings("unchecked")
public <T> MatchBinder predicate(
@@ -109,6 +111,7 @@ public final class MatchBinder {
* thrown for inputs that fail to match.
*
* @param action the default action
+ * @return the binder, with default action bound
*/
public MatchBinder otherwise(BiConsumer<Context, Object> action) {
if (customDefaultAction) {
diff --git a/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/spi/StatefulFunctionModule.java b/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/spi/StatefulFunctionModule.java
index 629a4c0..b47e224 100644
--- a/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/spi/StatefulFunctionModule.java
+++ b/statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/spi/StatefulFunctionModule.java
@@ -51,8 +51,8 @@ import org.apache.flink.statefun.sdk.io.Router;
* {@code org.apache.flink.statefun.sdk.spi.StatefulFunctionModule}, i.e. the fully qualified name
* of the {@link StatefulFunctionModule} class. Each line in the file should be the fully qualified
* class name of a module in that JAR that you want to register for the Stateful Functions
- * application. The configuration file may also be automatically generated using Google's
- * <ahref="https://github.com/google/auto/tree/master/service">AutoService</a> tool.
+ * application. The configuration file may also be automatically generated using Google's <a
+ * href="https://github.com/google/auto/tree/master/service">AutoService</a> tool.
*
* <p>Finally, to allow the Stateful Functions runtime to discover the registered modules, the JAR
* files containing the modules and provider configuration files should be added to a