org.springframework.boot.jackson

Enum JsonComponent.Scope

java.lang.Object

java.lang.Enum<JsonComponent.Scope>

org.springframework.boot.jackson.JsonComponent.Scope

All Implemented Interfaces:

Serializable, Comparable<JsonComponent.Scope>

Enclosing class:

JsonComponent

public static enum JsonComponent.Scope
extends Enum<JsonComponent.Scope>

The various scopes under which a serializer/deserializer can be registered.

Enum Constant Summary

Enum Constants

Enum Constant and Description
KEYS A serializer/deserializer for keys.
VALUES A serializer/deserializer for regular value content.

Method Summary

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

VALUES

public static final JsonComponent.Scope VALUES

A serializer/deserializer for regular value content.

See Also:

JsonSerializer, JsonDeserializer

KEYS

public static final JsonComponent.Scope KEYS

A serializer/deserializer for keys.

See Also:

JsonSerializer, KeyDeserializer

Method Detail

values

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

Returns:

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

valueOf

public static JsonComponent.Scope 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