lucene-java-3.5.0/lucene/contrib/highlighter/src/java/org/apache/lucene/search/highlight/Encoder.java

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