01: package org.apache.lucene.ant;
02:
03: /**
04: * Licensed to the Apache Software Foundation (ASF) under one or more
05: * contributor license agreements. See the NOTICE file distributed with
06: * this work for additional information regarding copyright ownership.
07: * The ASF licenses this file to You under the Apache License, Version 2.0
08: * (the "License"); you may not use this file except in compliance with
09: * the License. You may obtain a copy of the License at
10: *
11: * http://www.apache.org/licenses/LICENSE-2.0
12: *
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.
18: */
19:
20: import org.apache.lucene.document.Document;
21:
22: import java.io.File;
23:
24: /**
25: * Allows a class to act as a Lucene document handler
26: *
27: *@author Erik Hatcher
28: *@since October 27, 2001
29: */
30: public interface DocumentHandler {
31:
32: /**
33: * Gets the document attribute of the DocumentHandler object
34: *
35: *@param file Description of Parameter
36: *@return The document value
37: */
38: Document getDocument(File file) throws DocumentHandlerException;
39: }
|