com.github.wnameless.json.flattener

Enum FlattenMode

java.lang.Object

java.lang.Enum<FlattenMode>

com.github.wnameless.json.flattener.FlattenMode

All Implemented Interfaces:

Serializable, Comparable<FlattenMode>

public enum FlattenMode
extends Enum<FlattenMode>

FlattenMode lists all acceptable modes of the JsonFlattener.

Author:

Wei-Ming Wu

Enum Constant Summary

Enum Constants

Enum Constant and Description
KEEP_ARRAYS Flattens every objects except arrays.
MONGODB Conforms to MongoDB dot.notation to update also nested documents.
NORMAL Flattens every objects.

Method Summary

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

NORMAL

public static final FlattenMode NORMAL

Flattens every objects.

KEEP_ARRAYS

public static final FlattenMode KEEP_ARRAYS

Flattens every objects except arrays.

MONGODB

public static final FlattenMode MONGODB

Conforms to MongoDB dot.notation to update also nested documents.

Method Detail

values

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

Returns:

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

valueOf

public static FlattenMode 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