Package org.springframework.data.mongodb.core.convert

Enum Class ReferenceLoader.NoResultsFilter

java.lang.Object

java.lang.Enum<ReferenceLoader.NoResultsFilter>

org.springframework.data.mongodb.core.convert.ReferenceLoader.NoResultsFilter

All Implemented Interfaces:

Serializable, Comparable<ReferenceLoader.NoResultsFilter>, Constable, ReferenceLoader.DocumentReferenceQuery

Enclosing interface:

ReferenceLoader

public static enum ReferenceLoader.NoResultsFilter
extends Enum<ReferenceLoader.NoResultsFilter>
implements ReferenceLoader.DocumentReferenceQuery

A dedicated ReferenceLoader.DocumentReferenceQuery that will not match any documents.

Since:

4.2.5

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
org.bson.conversions.Bson	getQuery()	Get the query to obtain matching documents.
static ReferenceLoader.NoResultsFilter	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ReferenceLoader.NoResultsFilter[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.data.mongodb.core.convert.ReferenceLoader.DocumentReferenceQuery

apply, getSort, restoreOrder

Enum Constant Details

INSTANCE

public static final ReferenceLoader.NoResultsFilter INSTANCE

Method Details

values

public static ReferenceLoader.NoResultsFilter[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ReferenceLoader.NoResultsFilter valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getQuery

public org.bson.conversions.Bson getQuery()

Description copied from interface: ReferenceLoader.DocumentReferenceQuery

Get the query to obtain matching documents.

Specified by:

getQuery in interface ReferenceLoader.DocumentReferenceQuery

Returns:

never null.