SpanPayloadCheckQuery (The Adobe Experience Manager SDK 2021.8.5705.20210810T082946Z-210700)

java.lang.Object
- org.apache.lucene.search.Query
- - org.apache.lucene.search.spans.SpanQuery
  - - org.apache.lucene.search.spans.SpanPositionCheckQuery
    - - org.apache.lucene.search.spans.SpanPayloadCheckQuery

All Implemented Interfaces:

Cloneable
```
public class SpanPayloadCheckQuery
extends SpanPositionCheckQuery
```
Only return those matches that have a specific payload at the given position.
Do not use this with an SpanQuery that contains a SpanNearQuery. Instead, use SpanNearPayloadCheckQuery since it properly handles the fact that payloads aren't ordered by SpanNearQuery.

Constructor Summary

Constructors
Constructor Description

SpanPayloadCheckQuery(SpanQuery match, Collection<byte[]> payloadToMatch)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SpanPayloadCheckQuery`	`clone()`	Returns a clone of this query.
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`String`	`toString(String field)`	Prints a query to a string, with `field` assumed to be the default field and omitted.

Methods inherited from class org.apache.lucene.search.spans.SpanPositionCheckQuery
extractTerms, getField, getMatch, getSpans, rewrite

Methods inherited from class org.apache.lucene.search.spans.SpanQuery
createWeight

Methods inherited from class org.apache.lucene.search.Query
getBoost, setBoost, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SpanPayloadCheckQuery
```
public SpanPayloadCheckQuery(SpanQuery match,
                             Collection<byte[]> payloadToMatch)
```
    Parameters:
    
    match - The underlying SpanQuery to check
    
    payloadToMatch - The Collection of payloads to match
- Method Detail
  - toString
```
public String toString(String field)
```
    Description copied from class: Query
    
    Prints a query to a string, with field assumed to be the default field and omitted.
    
    Specified by:
    
    toString in class Query
  - clone
```
public SpanPayloadCheckQuery clone()
```
    Description copied from class: Query
    
    Returns a clone of this query.
    
    Overrides:
    
    clone in class Query
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Query
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Query