[flink] 01/05: [hotfix] Add JavaDocs to CheckpointMetadataOutputStream

[se...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sewen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git

commit 9aeb3813593613868cbf106d922986bb28201881
Author: Stephan Ewen <se...@apache.org>
AuthorDate: Sun Sep 23 22:37:56 2018 +0200

    [hotfix] Add JavaDocs to CheckpointMetadataOutputStream
---
 .../runtime/state/CheckpointMetadataOutputStream.java     | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/state/CheckpointMetadataOutputStream.java b/flink-runtime/src/main/java/org/apache/flink/runtime/state/CheckpointMetadataOutputStream.java
index 4180e88..70aff7e 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/state/CheckpointMetadataOutputStream.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/state/CheckpointMetadataOutputStream.java
@@ -22,8 +22,23 @@ import org.apache.flink.core.fs.FSDataOutputStream;
 
 import java.io.IOException;
 
+/**
+ * An output stream for checkpoint metadata.
+ *
+ * <p>This stream is similar to the {@link CheckpointStreamFactory.CheckpointStateOutputStream},
+ * but for metadata files rather thancdata files.
+ *
+ * <p>This stream always creates a file, regardless of the amount of data written.
+ */
 public abstract class CheckpointMetadataOutputStream extends FSDataOutputStream {
 
+	/**
+	 * Closes the stream after all metadata was written and finalizes the checkpoint location.
+	 *
+	 * @return An object representing a finalized checkpoint storage location.
+	 *
+	 * @throws IOException Thrown, if the stream cannot be closed or the finalization fails.
+	 */
 	public abstract CompletedCheckpointStorageLocation closeAndFinalizeCheckpoint() throws IOException;
 
 	/**