## Uses of Class
org.apache.lucene.search.payloads.PayloadFunction

Packages that use PayloadFunction
Package | Description
--- | ---
org.apache.lucene.search.payloads | The payloads package provides Query mechanisms for finding and using payloads.

### Uses of PayloadFunction in org.apache.lucene.search.payloads

Subclasses of PayloadFunction in org.apache.lucene.search.payloads
Modifier and Type | Class and Description
--- | ---
`class` | `AveragePayloadFunction` Calculate the final score as the average score of all payloads seen.
`class` | `MaxPayloadFunction` Returns the maximum payload score seen, else 1 if there are no payloads on the doc.
`class` | `MinPayloadFunction` Calculates the minimum payload seen

Fields in org.apache.lucene.search.payloads declared as PayloadFunction
Modifier and Type | Field and Description
--- | ---
`protected PayloadFunction` | PayloadTermQuery.`function`
`protected PayloadFunction` | PayloadNearQuery.`function`

Constructors in org.apache.lucene.search.payloads with parameters of type PayloadFunction
Constructor and Description
`PayloadNearQuery(SpanQuery[] clauses, int slop, boolean inOrder, PayloadFunction function)`
`PayloadTermQuery(Term term, PayloadFunction function)`
`PayloadTermQuery(Term term, PayloadFunction function, boolean includeSpanScore)`