01: package org.apache.lucene.search.highlight;
02:
03: /**
04: * Copyright 2005 The Apache Software Foundation
05: *
06: * Licensed under the Apache License, Version 2.0 (the "License");
07: * you may not use this file except in compliance with the License.
08: * You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing, software
13: * distributed under the License is distributed on an "AS IS" BASIS,
14: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15: * See the License for the specific language governing permissions and
16: * limitations under the License.
17: */
18:
19: /**
20: * Encodes original text. The Encoder works with the Formatter to generate the
21: * output.
22: *
23: * @author Nicko Cadell
24: */
25: public interface Encoder {
26: /**
27: * @param originalText
28: * The section of text being output
29: */
30: String encodeText(String originalText);
31: }
|