## Uses of Class
org.apache.lucene.index.Payload

- Packages that use Payload
  Package | Description
  --- | ---
  org.apache.lucene.analysis | API and code to convert text into indexable/searchable tokens.
  org.apache.lucene.analysis.payloads | Provides various convenience classes for creating payloads on Tokens.
  org.apache.lucene.analysis.tokenattributes |

- - ### Uses of Payload in org.apache.lucene.analysis

    Methods in org.apache.lucene.analysis that return Payload
    Modifier and Type | Method and Description
    --- | ---
    `Payload` | Token.`getPayload()` Returns this Token's payload.

    Methods in org.apache.lucene.analysis with parameters of type Payload
    Modifier and Type | Method and Description
    --- | ---
    `void` | Token.`setPayload(Payload payload)` Sets this Token's payload.

  - ### Uses of Payload in org.apache.lucene.analysis.payloads

    Methods in org.apache.lucene.analysis.payloads that return Payload
    Modifier and Type | Method and Description
    --- | ---
    `Payload` | PayloadEncoder.`encode(char[] buffer)`
    `Payload` | AbstractEncoder.`encode(char[] buffer)`
    `Payload` | FloatEncoder.`encode(char[] buffer, int offset, int length)`
    `Payload` | IdentityEncoder.`encode(char[] buffer, int offset, int length)`
    `Payload` | PayloadEncoder.`encode(char[] buffer, int offset, int length)` Convert a char array to a `Payload`
    `Payload` | IntegerEncoder.`encode(char[] buffer, int offset, int length)`

  - ### Uses of Payload in org.apache.lucene.analysis.tokenattributes

    Methods in org.apache.lucene.analysis.tokenattributes that return Payload
    Modifier and Type | Method and Description
    --- | ---
    `Payload` | PayloadAttributeImpl.`getPayload()` Returns this Token's payload.
    `Payload` | PayloadAttribute.`getPayload()` Returns this Token's payload.

    Methods in org.apache.lucene.analysis.tokenattributes with parameters of type Payload
    Modifier and Type | Method and Description
    --- | ---
    `void` | PayloadAttributeImpl.`setPayload(Payload payload)` Sets this Token's payload.
    `void` | PayloadAttribute.`setPayload(Payload payload)` Sets this Token's payload.

    Constructors in org.apache.lucene.analysis.tokenattributes with parameters of type Payload
    Constructor and Description
    `PayloadAttributeImpl(Payload payload)` Initialize this attribute with the given payload.

Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.