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.util.Collection;
24 abstract class DocFieldConsumer {
26 FieldInfos fieldInfos;
28 /** Called when DocumentsWriter decides to create a new
30 abstract void flush(Map<DocFieldConsumerPerThread,Collection<DocFieldConsumerPerField>> threadsAndFields, SegmentWriteState state) throws IOException;
32 /** Called when an aborting exception is hit */
33 abstract void abort();
35 /** Add a new thread */
36 abstract DocFieldConsumerPerThread addThread(DocFieldProcessorPerThread docFieldProcessorPerThread) throws IOException;
38 /** Called when DocumentsWriter is using too much RAM.
39 * The consumer should free RAM, if possible, returning
40 * true if any RAM was in fact freed. */
41 abstract boolean freeRAM();
43 void setFieldInfos(FieldInfos fieldInfos) {
44 this.fieldInfos = fieldInfos;