lucene-java-3.4.0/lucene/src/java/org/apache/lucene/analysis/tokenattributes/PayloadAttribute.java

   1 package org.apache.lucene.analysis.tokenattributes;
   2
   3 /**
   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
  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.index.Payload;
  21 import org.apache.lucene.util.Attribute;
  22
  23 /**
  24  * The payload of a Token. See also {@link Payload}.
  25  */
  26 public interface PayloadAttribute extends Attribute {
  27   /**
  28    * Returns this Token's payload.
  29    */
  30   public Payload getPayload();
  31
  32   /**
  33    * Sets this Token's payload.
  34    */
  35   public void setPayload(Payload payload);
  36 }