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
  • 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