software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute

Class BooleanAttributeConverter

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.BooleanAttributeConverter

All Implemented Interfaces:

AttributeConverter<Boolean>, PrimitiveConverter<Boolean>

@ThreadSafe
 @Immutable
public final class BooleanAttributeConverter
extends Object
implements AttributeConverter<Boolean>, PrimitiveConverter<Boolean>

A converter between AtomicBoolean and AttributeValue.

This stores values in DynamoDB as a boolean.

This supports reading every boolean value supported by DynamoDB, making it fully compatible with custom converters as well as internal converters (e.g. AtomicBooleanAttributeConverter).

This can be created via create().

Method Summary

Modifier and Type	Method and Description
AttributeValueType	attributeValueType() The AttributeValueType that a converter stores and reads values from DynamoDB via the AttributeValue class.
static BooleanAttributeConverter	create()
EnhancedType<Boolean>	primitiveType() The type supported by this converter.
AttributeValue	transformFrom(Boolean input) Convert the provided Java object into an AttributeValue.
Boolean	transformTo(AttributeValue input) Convert the provided AttributeValue into a Java object.
EnhancedType<Boolean>	type() The type supported by this converter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static BooleanAttributeConverter create()

type

public EnhancedType<Boolean> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<Boolean>

attributeValueType

public AttributeValueType attributeValueType()

Description copied from interface: AttributeConverter

The AttributeValueType that a converter stores and reads values from DynamoDB via the AttributeValue class.

Specified by:

attributeValueType in interface AttributeConverter<Boolean>

transformFrom

public AttributeValue transformFrom(Boolean input)

Description copied from interface: AttributeConverter

Convert the provided Java object into an AttributeValue. This will raise a RuntimeException if the conversion fails, or the input is null.

Example:

 
 InstantAsStringAttributeConverter converter = InstantAsStringAttributeConverter.create();
 assertEquals(converter.transformFrom(Instant.EPOCH),
              EnhancedAttributeValue.fromString("1970-01-01T00:00:00Z").toAttributeValue());
 
 

Specified by:

transformFrom in interface AttributeConverter<Boolean>

transformTo

public Boolean transformTo(AttributeValue input)

Description copied from interface: AttributeConverter

Convert the provided AttributeValue into a Java object. This will raise a RuntimeException if the conversion fails, or the input is null.

 Example:
 
 InstantAsStringAttributeConverter converter = InstantAsStringAttributeConverter.create();
 assertEquals(converter.transformTo(EnhancedAttributeValue.fromString("1970-01-01T00:00:00Z").toAttributeValue()),
              Instant.EPOCH);
 
 

Specified by:

transformTo in interface AttributeConverter<Boolean>

primitiveType

public EnhancedType<Boolean> primitiveType()

Description copied from interface: PrimitiveConverter

The type supported by this converter.

Specified by:

primitiveType in interface PrimitiveConverter<Boolean>