com.datastax.oss.dsbulk.codecs.api.util

Enum OverflowStrategy

java.lang.Object

java.lang.Enum<OverflowStrategy>

com.datastax.oss.dsbulk.codecs.api.util.OverflowStrategy

All Implemented Interfaces:

Serializable, Comparable<OverflowStrategy>

public enum OverflowStrategy
extends Enum<OverflowStrategy>

A strategy to apply in case of overflow.

Overflows can happen in the following situations:

• The value is outside the range of the target CQL type. For example, trying to convert 128 to a CQL tinyint (max value of 127) results in overflow.
• The value is decimal, but the target CQL type is integral. For example, trying to convert 123.45 to a CQL int results in overflow.
• The value's precision is too large for the target CQL type. For example, trying to insert 0.1234567890123456789 into a CQL double results in overflow, because there are too many significant digits to fit in a 64-bit double.

Enum Constant Summary

Enum Constants

Enum Constant and Description
REJECT Overflows are considered errors and the data is rejected.
TRUNCATE The data is truncated to fit in the target CQL type.

Method Summary

Modifier and Type	Method and Description
abstract Number	apply(Number value, ArithmeticException e, Class<? extends Number> targetClass, RoundingMode roundingMode)
static OverflowStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static OverflowStrategy[]	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

REJECT

public static final OverflowStrategy REJECT

Overflows are considered errors and the data is rejected.

TRUNCATE

public static final OverflowStrategy TRUNCATE

The data is truncated to fit in the target CQL type. The truncation algorithm is similar to the narrowing primitive conversion defined in The Java Language Specification, Section 5.1.3, with the following exceptions:

• If the value is too big or too small, it is rounded up or down to the maximum or minimum value allowed, rather than truncated at bit level. For example, 128 would be rounded down to 127 to fit in a byte, whereas Java would have truncated the exceeding bits and converted to -127 instead.
• If the value is decimal, but the target CQL type is integral, it is first rounded to an integral using the defined rounding strategy, then narrowed to fit into the target type. This can result in precision loss and should be used with caution.

Method Detail

values

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

Returns:

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

valueOf

public static OverflowStrategy 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

apply

public abstract Number apply(Number value,
                             ArithmeticException e,
                             Class<? extends Number> targetClass,
                             RoundingMode roundingMode)