Github user punya commented on a diff in the pull request:
https://github.com/apache/spark/pull/5603#discussion_r28838980
--- Diff: core/src/main/java/org/apache/spark/io/RecordReader.java ---
@@ -0,0 +1,53 @@
+/*
+ * 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.spark.io;
+
+import java.io.Closeable;
+import java.io.IOException;
+
+import org.apache.spark.annotation.Experimental;
+
+/**
+ * A reader that reads records in one by one.
+ */
+@Experimental
+public abstract class RecordReader<T> implements Closeable {
+
+ /**
+ * Fetches the next record.
+ *
+ * @return true if we read a record.
+ */
+ public abstract boolean fetchNext() throws InterruptedException,
IOException;
+
+ /**
+ * Returns the current record. [[fetchNext]] must have been called
before this.
--- End diff --
This should say that callers shouldn't rely on this value being unchanged
after a subsequent call to `fetchNext`. Also, you should write `{@link
#fetchNext}` rather than `[[fetchNext]]` for javadoc compatibility.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
