Module spring.data.mongodb

Package org.springframework.data.mongodb.core.query

Enum Class MongoRegexCreator

java.lang.Object

java.lang.Enum<MongoRegexCreator>

org.springframework.data.mongodb.core.query.MongoRegexCreator

All Implemented Interfaces:

Serializable, Comparable<MongoRegexCreator>, Constable

public enum MongoRegexCreator
extends Enum<MongoRegexCreator>

Since:

1.8

Author:

Christoph Strobl, Mark Paluch, Jens Schauder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MongoRegexCreator.MatchMode	Match modes for treatment of String values.

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
Object	toCaseInsensitiveMatch(Object source)	Deprecated, for removal: This API element is subject to removal in a future version. since 4.1.1
String	toRegularExpression(String source, MongoRegexCreator.MatchMode matcherType)	Creates a regular expression String to be used with $regex.
static MongoRegexCreator	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MongoRegexCreator[]	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

Enum Constant Details

INSTANCE

public static final MongoRegexCreator INSTANCE

Method Details

values

public static MongoRegexCreator[] 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 MongoRegexCreator 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

toRegularExpression

@Nullable
public String toRegularExpression(@Nullable
 String source,
 @Nullable
 MongoRegexCreator.MatchMode matcherType)

Creates a regular expression String to be used with $regex.

Parameters:

source - the plain String

matcherType - the type of matching to perform

Returns:

source when source or matcherType is null.

toCaseInsensitiveMatch

@Deprecated(since="4.1.1",
            forRemoval=true)
public Object toCaseInsensitiveMatch(Object source)

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.1.1

Parameters:

source -

Returns:

Since:

2.2.14