lucene-java-3.5.0/lucene/contrib/analyzers/common/src/java/org/apache/lucene/analysis/payloads/PayloadEncoder.java

   1 package org.apache.lucene.analysis.payloads;
   2 /**
   3  * Licensed to the Apache Software Foundation (ASF) under one or more
   4  * contributor license agreements.  See the NOTICE file distributed with
   5  * this work for additional information regarding copyright ownership.
   6  * The ASF licenses this file to You under the Apache License, Version 2.0
   7  * (the "License"); you may not use this file except in compliance with
   8  * the License.  You may obtain a copy of the License at
   9  *
  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 import org.apache.lucene.index.Payload;
  20
  21
  22 /**
  23  * Mainly for use with the DelimitedPayloadTokenFilter, converts char buffers to Payload.
  24  * <p/>
  25  * NOTE: This interface is subject to change
  26  *
  27  **/
  28 public interface PayloadEncoder {
  29
  30   Payload encode(char[] buffer);
  31
  32   /**
  33    * Convert a char array to a {@link org.apache.lucene.index.Payload}
  34    * @param buffer
  35    * @param offset
  36    * @param length
  37    * @return encoded {@link Payload}
  38    */
  39   Payload encode(char [] buffer, int offset, int length);
  40 }