software.amazon.awssdk.extensions.dynamodb.mappingclient.staticmapper

Class AttributeTag

java.lang.Object

software.amazon.awssdk.extensions.dynamodb.mappingclient.staticmapper.AttributeTag

public abstract class AttributeTag
extends Object

Extend this class to create your own attribute tag that can be used with extensions.

Constructor Summary

Constructors

Constructor and Description
AttributeTag()

Method Summary

Modifier and Type	Method and Description
protected abstract Map<String,Object>	getCustomMetadataForAttribute(String attributeName, AttributeValueType attributeValueType) Attribute tags are recorded in the TableMetadata object as custom metadata objects with a string key and a flexible value type.
protected abstract boolean	isKeyAttribute() Returns a boolean that indicates whether this attribute tag qualifies the attribute that has been tagged with it as a 'key attribute'.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeTag

public AttributeTag()

Method Detail

getCustomMetadataForAttribute

protected abstract Map<String,Object> getCustomMetadataForAttribute(String attributeName,
                                                                    AttributeValueType attributeValueType)

Attribute tags are recorded in the TableMetadata object as custom metadata objects with a string key and a flexible value type. This method will be called whenever this object is used to tag an attribute in a StaticTableSchema.

Parameters:

attributeName - The name of the attribute this tag has been applied to.

attributeValueType - The type of the attribute this tag has been applied to. This can be used for validation, for instance if you have an attribute tag that should only be associated with a string.

Returns:

A map of custom metadata map entries that will be added to the custom metadata stored in the TableMetadata object for the table being mapped. Your extension should know what to do with these custom metadata entries.

isKeyAttribute

protected abstract boolean isKeyAttribute()

Returns a boolean that indicates whether this attribute tag qualifies the attribute that has been tagged with it as a 'key attribute'. This is used by other extensions to determine how the attribute should be treated, for instance the encryption extension will not encrypt any attributes marked as 'key attributes' by default.

Returns:

true if this attribute should be considered a 'key attribute'; false if not.