pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.5.0 / lucene / src / java / org / apache / lucene / analysis / tokenattributes / PayloadAttribute.java
diff --git a/lucene-java-3.5.0/lucene/src/java/org/apache/lucene/analysis/tokenattributes/PayloadAttribute.java b/lucene-java-3.5.0/lucene/src/java/org/apache/lucene/analysis/tokenattributes/PayloadAttribute.java
new file mode 100644 (file)
index 0000000..006cc5e
--- /dev/null
@@ -0,0 +1,36 @@
+package org.apache.lucene.analysis.tokenattributes;
+
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import org.apache.lucene.index.Payload;
+import org.apache.lucene.util.Attribute;
+
+/**
+ * The payload of a Token. See also {@link Payload}.
+ */
+public interface PayloadAttribute extends Attribute {
+  /**
+   * Returns this Token's payload.
+   */ 
+  public Payload getPayload();
+
+  /** 
+   * Sets this Token's payload.
+   */
+  public void setPayload(Payload payload);
+}