Package org.springframework.data.mongodb.core.schema

Class QueryCharacteristics

java.lang.Object

org.springframework.data.mongodb.core.schema.QueryCharacteristics

All Implemented Interfaces:

Iterable<QueryCharacteristic>, Supplier<Stream<QueryCharacteristic>>, Streamable<QueryCharacteristic>

public class QueryCharacteristics
extends Object
implements Streamable<QueryCharacteristic>

Encapsulation of individual query characteristics used to define queries that can be executed when using queryable encryption.

Since:

4.5

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryCharacteristics.EqualityQuery<T>	QueryCharacteristic for equality comparison.
static class	QueryCharacteristics.RangeQuery<T>	QueryCharacteristic for range comparison.

Method Summary

Modifier and Type	Method	Description
static <T> QueryCharacteristics.EqualityQuery<T>	equality()	Create a new equality query characteristic used to define equality queries against an encrypted field.
List<QueryCharacteristic>	getCharacteristics()
Iterator<QueryCharacteristic>	iterator()
static QueryCharacteristics	none()
static QueryCharacteristics	of(List<QueryCharacteristic> characteristics)	Create new QueryCharacteristics from given list of characteristics.
static QueryCharacteristics	of(QueryCharacteristic... characteristics)	Create new QueryCharacteristics from given characteristics.
static <T> QueryCharacteristics.RangeQuery<T>	range()	Create a new range query characteristic used to define range queries against an encrypted field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.springframework.data.util.Streamable

and, and, and, and, filter, flatMap, get, isEmpty, map, stream, toList, toSet

Method Details

none

public static QueryCharacteristics none()

Returns:

marker instance indicating no characteristics have been defined.

of

public static QueryCharacteristics of(List<QueryCharacteristic> characteristics)

Create new QueryCharacteristics from given list of characteristics.

Parameters:

characteristics - must not be null.

Returns:

new instance of QueryCharacteristics.

of

public static QueryCharacteristics of(QueryCharacteristic... characteristics)

Create new QueryCharacteristics from given characteristics.

Parameters:

characteristics - must not be null.

Returns:

new instance of QueryCharacteristics.

getCharacteristics

public List<QueryCharacteristic> getCharacteristics()

Returns:

the list of characteristics.

iterator

public Iterator<QueryCharacteristic> iterator()

Specified by:

iterator in interface Iterable<QueryCharacteristic>

range

public static <T>
QueryCharacteristics.RangeQuery<T> range()

Create a new range query characteristic used to define range queries against an encrypted field.

Type Parameters:

T - targeted field type

Returns:

new instance of QueryCharacteristics.RangeQuery.

equality

public static <T>
QueryCharacteristics.EqualityQuery<T> equality()

Create a new equality query characteristic used to define equality queries against an encrypted field.

Type Parameters:

T - targeted field type

Returns:

new instance of QueryCharacteristics.EqualityQuery.