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

Class TypeConvertingVisitor<T>

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.internal.converter.TypeConvertingVisitor<T>

@SdkInternalApi
public abstract class TypeConvertingVisitor<T>
extends Object

A visitor across all possible types of a EnhancedAttributeValue.

This is useful in AttributeConverter implementations, without having to write a switch statement on the EnhancedAttributeValue.type().

See Also:

• EnhancedAttributeValue.convert(TypeConvertingVisitor)

Field Summary

Fields

Modifier and Type	Field	Description
protected final Class<?>	targetType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TypeConvertingVisitor(Class<?> targetType)	Called by subclasses to provide enhanced logging when a specific type isn't handled.
protected	TypeConvertingVisitor(Class<?> targetType, Class<?> converterClass)	Called by subclasses to provide enhanced logging when a specific type isn't handled.

Method Summary

Modifier and Type	Method	Description
final T	convert(EnhancedAttributeValue value)	Convert the provided value into the target type.
T	convertBoolean(Boolean value)	Invoked when visiting an attribute in which EnhancedAttributeValue.isBoolean() is true.
T	convertBytes(SdkBytes value)	Invoked when visiting an attribute in which EnhancedAttributeValue.isBytes() is true.
T	convertListOfAttributeValues(List<AttributeValue> value)	Invoked when visiting an attribute in which EnhancedAttributeValue.isListOfAttributeValues() is true.
T	convertMap(Map<String,AttributeValue> value)	Invoked when visiting an attribute in which EnhancedAttributeValue.isMap() is true.
T	convertNull()	Invoked when visiting an attribute in which EnhancedAttributeValue.isNull() is true.
T	convertNumber(String value)	Invoked when visiting an attribute in which EnhancedAttributeValue.isNumber() is true.
T	convertSetOfBytes(List<SdkBytes> value)	Invoked when visiting an attribute in which EnhancedAttributeValue.isSetOfBytes() is true.
T	convertSetOfNumbers(List<String> value)	Invoked when visiting an attribute in which EnhancedAttributeValue.isSetOfNumbers() is true.
T	convertSetOfStrings(List<String> value)	Invoked when visiting an attribute in which EnhancedAttributeValue.isSetOfStrings() is true.
T	convertString(String value)	Invoked when visiting an attribute in which EnhancedAttributeValue.isString() is true.
T	defaultConvert(AttributeValueType type, Object value)	This is invoked by default if a different "convert" method is not overridden.

Methods inherited from class java.lang.Object

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

Field Details

targetType

protected final Class<?> targetType

Constructor Details

TypeConvertingVisitor

protected TypeConvertingVisitor(Class<?> targetType)

Called by subclasses to provide enhanced logging when a specific type isn't handled.

Reasons this call may fail with a RuntimeException:

1. If the provided type is null.

Parameters:

targetType - The type to which this visitor is converting.

TypeConvertingVisitor

protected TypeConvertingVisitor(Class<?> targetType,
 Class<?> converterClass)

Called by subclasses to provide enhanced logging when a specific type isn't handled.

Reasons this call may fail with a RuntimeException:

1. If the provided type is null.

Parameters:

targetType - The type to which this visitor is converting.

converterClass - The converter implementation that is creating this visitor. This may be null.

Method Details

convert

public final T convert(EnhancedAttributeValue value)

Convert the provided value into the target type.

Reasons this call may fail with a RuntimeException:

1. If the value cannot be converted by this visitor.

convertNull

public T convertNull()

Invoked when visiting an attribute in which EnhancedAttributeValue.isNull() is true.

convertMap

public T convertMap(Map<String,AttributeValue> value)

Invoked when visiting an attribute in which EnhancedAttributeValue.isMap() is true. The provided value is the underlying value of the EnhancedAttributeValue being converted.

convertString

public T convertString(String value)

Invoked when visiting an attribute in which EnhancedAttributeValue.isString() is true. The provided value is the underlying value of the EnhancedAttributeValue being converted.

convertNumber

public T convertNumber(String value)

Invoked when visiting an attribute in which EnhancedAttributeValue.isNumber() is true. The provided value is the underlying value of the EnhancedAttributeValue being converted.

convertBytes

public T convertBytes(SdkBytes value)

Invoked when visiting an attribute in which EnhancedAttributeValue.isBytes() is true. The provided value is the underlying value of the EnhancedAttributeValue being converted.

convertBoolean

public T convertBoolean(Boolean value)

Invoked when visiting an attribute in which EnhancedAttributeValue.isBoolean() is true. The provided value is the underlying value of the EnhancedAttributeValue being converted.

convertSetOfStrings

public T convertSetOfStrings(List<String> value)

Invoked when visiting an attribute in which EnhancedAttributeValue.isSetOfStrings() is true. The provided value is the underlying value of the EnhancedAttributeValue being converted.

convertSetOfNumbers

public T convertSetOfNumbers(List<String> value)

Invoked when visiting an attribute in which EnhancedAttributeValue.isSetOfNumbers() is true. The provided value is the underlying value of the EnhancedAttributeValue being converted.

convertSetOfBytes

public T convertSetOfBytes(List<SdkBytes> value)

Invoked when visiting an attribute in which EnhancedAttributeValue.isSetOfBytes() is true. The provided value is the underlying value of the EnhancedAttributeValue being converted.

convertListOfAttributeValues

public T convertListOfAttributeValues(List<AttributeValue> value)

Invoked when visiting an attribute in which EnhancedAttributeValue.isListOfAttributeValues() is true. The provided value is the underlying value of the EnhancedAttributeValue being converted.

defaultConvert

public T defaultConvert(AttributeValueType type,
 Object value)

This is invoked by default if a different "convert" method is not overridden. By default, this throws an exception.

Parameters:

type - The type that wasn't handled by another "convert" method.

value - The value that wasn't handled by another "convert" method.