software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.FloatAttributeConverter Maven / Gradle / Ivy

Go to download
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

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

import software.amazon.awssdk.annotations.Immutable;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.enhanced.dynamodb.AttributeConverter;
import software.amazon.awssdk.enhanced.dynamodb.AttributeValueType;
import software.amazon.awssdk.enhanced.dynamodb.EnhancedType;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.ConverterUtils;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.PrimitiveConverter;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.TypeConvertingVisitor;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.string.FloatStringConverter;
import software.amazon.awssdk.services.dynamodb.model.AttributeValue;

/**
 * A converter between {@link Float} and {@link AttributeValue}.
 *
 * 
 * This stores values in DynamoDB as a number.
 *
 * 

 * This supports converting numbers stored in DynamoDB into a single-precision floating point number, within the range
 * {@link Float#MIN_VALUE}, {@link Float#MAX_VALUE}. For more precision or larger values, consider using
 * {@link DoubleAttributeConverter} or {@link BigDecimalAttributeConverter}.
 *
 * 

 * If values are known to be whole numbers, it is recommended to use a perfect-precision whole number representation like those
 * provided by {@link ShortAttributeConverter}, {@link IntegerAttributeConverter} or {@link BigIntegerAttributeConverter}.
 *
 * 
 * This can be created via {@link #create()}.
 */
@SdkInternalApi
@ThreadSafe
@Immutable
public final class FloatAttributeConverter implements AttributeConverter, PrimitiveConverter {
    private static final Visitor VISITOR = new Visitor();
    private static final FloatStringConverter STRING_CONVERTER = FloatStringConverter.create();

    private FloatAttributeConverter() {
    }

    public static FloatAttributeConverter create() {
        return new FloatAttributeConverter();
    }

    @Override
    public EnhancedType type() {
        return EnhancedType.of(Float.class);
    }

    @Override
    public AttributeValueType attributeValueType() {
        return AttributeValueType.N;
    }

    @Override
    public AttributeValue transformFrom(Float input) {
        ConverterUtils.validateFloat(input);
        return AttributeValue.builder().n(STRING_CONVERTER.toString(input)).build();
    }

    @Override
    public Float transformTo(AttributeValue input) {
        Float result;
        if (input.n() != null) {
            result = EnhancedAttributeValue.fromNumber(input.n()).convert(VISITOR);
        } else {
            result = EnhancedAttributeValue.fromAttributeValue(input).convert(VISITOR);
        }

        ConverterUtils.validateFloat(result);
        return result;
    }

    @Override
    public EnhancedType primitiveType() {
        return EnhancedType.of(float.class);
    }

    private static final class Visitor extends TypeConvertingVisitor {
        private Visitor() {
            super(Float.class, FloatAttributeConverter.class);
        }

        @Override
        public Float convertString(String value) {
            return STRING_CONVERTER.fromString(value);
        }

        @Override
        public Float convertNumber(String value) {
            return STRING_CONVERTER.fromString(value);
        }
    }
}