1 package org.apache.lucene.index;
4 * Licensed to the Apache Software Foundation (ASF) under one or more
5 * contributor license agreements. See the NOTICE file distributed with
6 * this work for additional information regarding copyright ownership.
7 * The ASF licenses this file to You under the Apache License, Version 2.0
8 * (the "License"); you may not use this file except in compliance with
9 * the License. You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
20 import java.io.IOException;
21 import java.io.Closeable;
23 /** Abstract class for enumerating terms.
25 <p>Term enumerations are always ordered by Term.compareTo(). Each term in
26 the enumeration is greater than all that precede it. */
28 public abstract class TermEnum implements Closeable {
29 /** Increments the enumeration to the next element. True if one exists.*/
30 public abstract boolean next() throws IOException;
32 /** Returns the current Term in the enumeration.*/
33 public abstract Term term();
35 /** Returns the docFreq of the current Term in the enumeration.*/
36 public abstract int docFreq();
38 /** Closes the enumeration to further activity, freeing resources. */
39 public abstract void close() throws IOException;