JingGe commented on a change in pull request #17501: URL: https://github.com/apache/flink/pull/17501#discussion_r732509201
########## File path: flink-connectors/flink-connector-files/src/main/java/org/apache/flink/connector/file/src/reader/RecordFormat.java ########## @@ -0,0 +1,130 @@ +/* + * 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.connector.file.src.reader; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.configuration.Configuration; +import org.apache.flink.connector.file.src.util.CheckpointedPosition; +import org.apache.flink.core.fs.FSDataInputStream; +import org.apache.flink.core.fs.FileStatus; +import org.apache.flink.core.fs.FileSystem; +import org.apache.flink.core.fs.Path; + +import java.io.IOException; + +import static org.apache.flink.util.Preconditions.checkArgument; +import static org.apache.flink.util.Preconditions.checkNotNull; + +/** + * A reader format that reads individual records from a file via {@link Path}. + * + * <p>This interface teams up with its superinterface together build a 2-levels API. {@link + * StreamFormat} focuses on abstract input stream and {@link RecordFormat} pays attention to the + * concrete FileSystem. This format is for cases where the readers need access to the file directly + * or need to create a custom stream. For readers that can directly work on input streams, consider + * using the superinterface {@link StreamFormat}. + * + * <p>Please refer the javadoc of {@link StreamFormat} for details. + * + * @param <T> - The type of records created by this format reader. + */ +@PublicEvolving +public interface RecordFormat<T> extends StreamFormat<T> { Review comment: Exactly, it is actually also hardly to find the difference between StreamFormat and FileRecordFormat. I've explained the intention of building this new interface in the "open questions" section above, please have a look. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
