zentol commented on code in PR #20757: URL: https://github.com/apache/flink/pull/20757#discussion_r968178154
########## flink-core/src/main/java/org/apache/flink/api/connector/source/lib/util/IteratorSourceReaderBase.java: ########## @@ -0,0 +1,164 @@ +/* + * 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.api.connector.source.lib.util; + +import org.apache.flink.annotation.Public; +import org.apache.flink.api.connector.source.SourceReader; +import org.apache.flink.api.connector.source.SourceReaderContext; +import org.apache.flink.core.io.InputStatus; + +import javax.annotation.Nullable; + +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Iterator; +import java.util.List; +import java.util.Queue; +import java.util.concurrent.CompletableFuture; + +import static org.apache.flink.util.Preconditions.checkNotNull; + +/** + * A {@link SourceReader} that returns the values of an iterator, supplied via an {@link + * IteratorSourceSplit}. + * + * <p>The {@code IteratorSourceSplit} is also responsible for taking the current iterator and + * turning it back into a split for checkpointing. + * + * @param <E> The type of events returned by the reader. + * @param <IterT> The type of the iterator that produces the events. This type exists to make the + * conversion between iterator and {@code IteratorSourceSplit} type safe. + * @param <SplitT> The concrete type of the {@code IteratorSourceSplit} that creates and converts + * the iterator that produces this reader's elements. + */ +@Public +abstract class IteratorSourceReaderBase< + E, O, IterT extends Iterator<E>, SplitT extends IteratorSourceSplit<E, IterT>> + implements SourceReader<O, SplitT> { + + /** The context for this reader, to communicate with the enumerator. */ + protected final SourceReaderContext context; + + /** The availability future. This reader is available as soon as a split is assigned. */ + protected CompletableFuture<Void> availability; + + /** + * The iterator producing data. Non-null after a split has been assigned. This field is null or + * non-null always together with the {@link #currentSplit} field. + */ + @Nullable protected IterT iterator; Review Comment: At first I thought we should merge the IteratorSourceReader and IteratorSourceReaderBase (because the IteratorSourceReader doesn't really contain anything), but this wouldn't work because we can't change the generics to allow a different output type than the input. So I'd leave it as is post-f1ed0ff14fb9cd79c910c3784aad109ab94e2d3c. ########## flink-core/src/main/java/org/apache/flink/api/connector/source/lib/util/IteratorSourceReaderBase.java: ########## @@ -0,0 +1,164 @@ +/* + * 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.api.connector.source.lib.util; + +import org.apache.flink.annotation.Public; +import org.apache.flink.api.connector.source.SourceReader; +import org.apache.flink.api.connector.source.SourceReaderContext; +import org.apache.flink.core.io.InputStatus; + +import javax.annotation.Nullable; + +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Iterator; +import java.util.List; +import java.util.Queue; +import java.util.concurrent.CompletableFuture; + +import static org.apache.flink.util.Preconditions.checkNotNull; + +/** + * A {@link SourceReader} that returns the values of an iterator, supplied via an {@link + * IteratorSourceSplit}. + * + * <p>The {@code IteratorSourceSplit} is also responsible for taking the current iterator and + * turning it back into a split for checkpointing. + * + * @param <E> The type of events returned by the reader. + * @param <IterT> The type of the iterator that produces the events. This type exists to make the + * conversion between iterator and {@code IteratorSourceSplit} type safe. + * @param <SplitT> The concrete type of the {@code IteratorSourceSplit} that creates and converts + * the iterator that produces this reader's elements. + */ +@Public +abstract class IteratorSourceReaderBase< + E, O, IterT extends Iterator<E>, SplitT extends IteratorSourceSplit<E, IterT>> + implements SourceReader<O, SplitT> { + + /** The context for this reader, to communicate with the enumerator. */ + protected final SourceReaderContext context; + + /** The availability future. This reader is available as soon as a split is assigned. */ + protected CompletableFuture<Void> availability; + + /** + * The iterator producing data. Non-null after a split has been assigned. This field is null or + * non-null always together with the {@link #currentSplit} field. + */ + @Nullable protected IterT iterator; Review Comment: At first I thought we should merge the IteratorSourceReader and IteratorSourceReaderBase (because the IteratorSourceReader doesn't really contain anything), but this wouldn't work because we can't change the generics to allow a different output type than the input. So I'd leave it as is post f1ed0ff14fb9cd79c910c3784aad109ab94e2d3c. -- 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
