org.springframework.data.mongodb.core.mapping

Enum Field.Write

java.lang.Object

java.lang.Enum<Field.Write>

org.springframework.data.mongodb.core.mapping.Field.Write

All Implemented Interfaces:

Serializable, Comparable<Field.Write>

Enclosing class:

Field

public static enum Field.Write
extends Enum<Field.Write>

Enumeration of write strategies to define when a property is included for write conversion.

Since:

3.3

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Value that indicates that property is to be always included, independent of value of the property.
NON_NULL Value that indicates that only properties with non-null values are to be included.

Method Summary

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

ALWAYS

public static final Field.Write ALWAYS

Value that indicates that property is to be always included, independent of value of the property.

NON_NULL

public static final Field.Write NON_NULL

Value that indicates that only properties with non-null values are to be included.

Method Detail

values

public static Field.Write[] 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 (Field.Write c : Field.Write.values())
    System.out.println(c);

Returns:

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

valueOf

public static Field.Write 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