Module spring.data.mongodb

Package org.springframework.data.mongodb.core.mapping

Enum Class FieldName.Type

java.lang.Object

java.lang.Enum<FieldName.Type>

org.springframework.data.mongodb.core.mapping.FieldName.Type

All Implemented Interfaces:

Serializable, Comparable<FieldName.Type>, Constable

Enclosing class:

FieldName

public static enum FieldName.Type
extends Enum<FieldName.Type>

The type defines how to treat a FieldName that contains special characters.

Since:

4.2

Author:

Christoph Strobl

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
KEY	Values are used as is.
PATH	Dot (.) characters are treated as separators for segments in a path.

Method Summary

Modifier and Type	Method	Description
static FieldName.Type	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FieldName.Type[]	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

PATH

public static final FieldName.Type PATH

Dot (.) characters are treated as separators for segments in a path.

KEY

public static final FieldName.Type KEY

Values are used as is.

Method Details

values

public static FieldName.Type[] 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 FieldName.Type 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