com.amazonaws.services.dynamodbv2.datamodeling

Enum DynamoDBMapperModelFactory.Schema

java.lang.Object

java.lang.Enum<DynamoDBMapperModelFactory.Schema>

com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapperModelFactory.Schema

All Implemented Interfaces:

Serializable, Comparable<DynamoDBMapperModelFactory.Schema>

Enclosing interface:

DynamoDBMapperModelFactory

public static enum DynamoDBMapperModelFactory.Schema
extends Enum<DynamoDBMapperModelFactory.Schema>

The enumeration of standard conversion schema versions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
V1_0 The V1 schema mapping, which retains strict backwards compatibility with the original DynamoDB data model.
V1_5 A V2 conversion schema which retains backwards compatibility with the V1 conversion schema for existing DynamoDB types, but adds the ability to marshall recursive structures using the new List and Map types.
V2_0 The native V2 conversion schema.

Field Summary

Fields

Modifier and Type	Field and Description
static DynamoDBMapperModelFactory.Schema	DEFAULT The default schema version.

Method Summary

Modifier and Type	Method and Description
boolean	compatible(DynamoDBMapperModelFactory.Schema schema) Returns true if this schema is compatible from the specified schema.
static DynamoDBMapperModelFactory.Schema	of(DynamoDBMapperConfig config) Gets the DynamoDBMapperModelFactory.Schema from the DynamoDBMapperConfig.
static DynamoDBMapperModelFactory.Schema	valueOf(String name) Returns the enum constant of this type with the specified name.
static DynamoDBMapperModelFactory.Schema[]	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

V1_0

public static final DynamoDBMapperModelFactory.Schema V1_0

The V1 schema mapping, which retains strict backwards compatibility with the original DynamoDB data model. In particular, it marshals Java Booleans as DynamoDB Numbers rather than the newer Boolean type, and does not support marshaling Lists or Maps. It can unmarshal values written in newer formats to ease migration.

Use me if you have other code still using an old version of the SDK that does not understand the new List and Map types and want to ensure that you don't accidentally start writing values using these types.

V1_5

public static final DynamoDBMapperModelFactory.Schema V1_5

A V2 conversion schema which retains backwards compatibility with the V1 conversion schema for existing DynamoDB types, but adds the ability to marshall recursive structures using the new List and Map types. This is currently the default conversion schema.

V2_0

public static final DynamoDBMapperModelFactory.Schema V2_0

The native V2 conversion schema. This schema breaks compatibility with older versions of the mapper that only support the V1 schema by storing booleans as native DynamoDB Booleans rather than as a 1 or 0 in a DynamoDB Number. Switching to the V2 schema will prevent older versions of the mapper from reading items you write that contain booleans.

Field Detail

DEFAULT

public static final DynamoDBMapperModelFactory.Schema DEFAULT

The default schema version.

Method Detail

values

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

Returns:

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

valueOf

public static DynamoDBMapperModelFactory.Schema 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

compatible

public boolean compatible(DynamoDBMapperModelFactory.Schema schema)

Returns true if this schema is compatible from the specified schema.

Parameters:

schema - The schema to compare.

Returns:

True if compatible, false otherwise.

of

public static DynamoDBMapperModelFactory.Schema of(DynamoDBMapperConfig config)

Gets the DynamoDBMapperModelFactory.Schema from the DynamoDBMapperConfig.

Parameters:

config - The DynamoDB mapper config.

Returns:

The schema.