Package software.amazon.smithy.model.node

Enum NodeMapper.WhenMissing

java.lang.Object

java.lang.Enum<NodeMapper.WhenMissing>

software.amazon.smithy.model.node.NodeMapper.WhenMissing

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NodeMapper.WhenMissing>

Enclosing class:

NodeMapper

public static enum NodeMapper.WhenMissing
extends java.lang.Enum<NodeMapper.WhenMissing>

Specifies the behavior of the mapper when attempting to deserialize an unknown property.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAIL	Throws an exception when attempting to deserialize an unknown property.
IGNORE	Ignores unknown properties.
WARN	Warns when attempting to deserialize an unknown property.

Method Summary

Modifier and Type	Method	Description
abstract void	handle(java.lang.reflect.Type into, java.lang.String pointer, java.lang.String property, Node value)	Invoked when an object property cannot be deserialized.
static NodeMapper.WhenMissing	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static NodeMapper.WhenMissing[]	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

FAIL

public static final NodeMapper.WhenMissing FAIL

Throws an exception when attempting to deserialize an unknown property.

WARN

public static final NodeMapper.WhenMissing WARN

Warns when attempting to deserialize an unknown property.

IGNORE

public static final NodeMapper.WhenMissing IGNORE

Ignores unknown properties.

Method Detail

values

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

Returns:

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

valueOf

public static NodeMapper.WhenMissing valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

handle

public abstract void handle(java.lang.reflect.Type into,
                            java.lang.String pointer,
                            java.lang.String property,
                            Node value)

Invoked when an object property cannot be deserialized.

Parameters:

into - The value type being created.

pointer - The JSON pointer to the type from the original node.

property - The property that was unknown to the type.

value - The Node being deserialized.