Github user jpountz commented on a diff in the pull request:
https://github.com/apache/lucene-solr/pull/345#discussion_r179442909
--- Diff:
lucene/core/src/java/org/apache/lucene/search/MatchesIterator.java ---
@@ -0,0 +1,69 @@
+/*
+ * 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.lucene.search;
+
+import java.io.IOException;
+
+import org.apache.lucene.index.LeafReaderContext;
+import org.apache.lucene.util.BytesRef;
+
+/**
+ * An iterator over match positions (and optionally offsets) for a single
document and field
+ *
+ * To iterate over the matches, call {@link #next()} until it returns
{@code false}, retrieving
+ * positions and/or offsets after each call. You should not call the
position or offset methods
+ * before {@link #next()} has been called, or after {@link #next()} has
returned {@code false}.
--- End diff --
I think it's worth repeating in the javadocs of each of these methods.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
