org.springframework.data.mongodb.core.query

Enum MongoRegexCreator

java.lang.Object

java.lang.Enum<MongoRegexCreator>

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

All Implemented Interfaces:

Serializable, Comparable<MongoRegexCreator>

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 and Description
static class	MongoRegexCreator.MatchMode Match modes for treatment of String values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
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 type with the specified name.
static MongoRegexCreator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final MongoRegexCreator INSTANCE

Method Detail

values

public static MongoRegexCreator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MongoRegexCreator c : MongoRegexCreator.values())
    System.out.println(c);

Returns:

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

valueOf

public static MongoRegexCreator valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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.