DecimalData (Flink : 1.17-SNAPSHOT API)

java.lang.Object
- org.apache.flink.table.data.DecimalData

All Implemented Interfaces:

Comparable<DecimalData>
```
@PublicEvolving
public final class DecimalData
extends Object
implements Comparable<DecimalData>
```
An internal data structure representing data of DecimalType.
This data structure is immutable and might store decimal values in a compact representation (as a long value) if values are small enough.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(DecimalData that)`
`DecimalData`	`copy()` Returns a copy of this `DecimalData` object.
`boolean`	`equals(Object o)`
`static DecimalData`	`fromBigDecimal(BigDecimal bd, int precision, int scale)` Creates an instance of `DecimalData` from a `BigDecimal` and the given precision and scale.
`static DecimalData`	`fromUnscaledBytes(byte[] unscaledBytes, int precision, int scale)` Creates an instance of `DecimalData` from an unscaled byte array value and the given precision and scale.
`static DecimalData`	`fromUnscaledLong(long unscaledLong, int precision, int scale)` Creates an instance of `DecimalData` from an unscaled long value and the given precision and scale.
`int`	`hashCode()`
`boolean`	`isCompact()` Returns whether the decimal value is small enough to be stored in a long.
`static boolean`	`isCompact(int precision)` Returns whether the decimal value is small enough to be stored in a long.
`int`	`precision()` Returns the precision of this `DecimalData`.
`int`	`scale()` Returns the scale of this `DecimalData`.
`BigDecimal`	`toBigDecimal()` Converts this `DecimalData` into an instance of `BigDecimal`.
`String`	`toString()`
`byte[]`	`toUnscaledBytes()` Returns a byte array describing the unscaled value of this `DecimalData`.
`long`	`toUnscaledLong()` Returns a long describing the unscaled value of this `DecimalData`.
`static DecimalData`	`zero(int precision, int scale)` Creates an instance of `DecimalData` for a zero value with the given precision and scale.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - precision
```
public int precision()
```
    Returns the precision of this DecimalData.
    The precision is the number of digits in the unscaled value.
  - scale
```
public int scale()
```
    Returns the scale of this DecimalData.
  - toBigDecimal
```
public BigDecimal toBigDecimal()
```
    Converts this DecimalData into an instance of BigDecimal.
  - toUnscaledLong
```
public long toUnscaledLong()
```
    Returns a long describing the unscaled value of this DecimalData.
    
    Throws:
    
    ArithmeticException - if this DecimalData does not exactly fit in a long.
  - toUnscaledBytes
```
public byte[] toUnscaledBytes()
```
    Returns a byte array describing the unscaled value of this DecimalData.
    
    Returns:
    
    the unscaled byte array of this DecimalData.
  - isCompact
```
public boolean isCompact()
```
    Returns whether the decimal value is small enough to be stored in a long.
  - copy
```
public DecimalData copy()
```
    Returns a copy of this DecimalData object.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(@Nonnull
                     DecimalData that)
```
    Specified by:
    
    compareTo in interface Comparable<DecimalData>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fromBigDecimal
```
@Nullable
public static DecimalData fromBigDecimal(BigDecimal bd,
                                                   int precision,
                                                   int scale)
```
    Creates an instance of DecimalData from a BigDecimal and the given precision and scale.
    The returned decimal value may be rounded to have the desired scale. The precision will be checked. If the precision overflows, null will be returned.
  - fromUnscaledLong
```
public static DecimalData fromUnscaledLong(long unscaledLong,
                                           int precision,
                                           int scale)
```
    Creates an instance of DecimalData from an unscaled long value and the given precision and scale.
  - fromUnscaledBytes
```
public static DecimalData fromUnscaledBytes(byte[] unscaledBytes,
                                            int precision,
                                            int scale)
```
    Creates an instance of DecimalData from an unscaled byte array value and the given precision and scale.
  - zero
```
@Nullable
public static DecimalData zero(int precision,
                                         int scale)
```
    Creates an instance of DecimalData for a zero value with the given precision and scale.
    The precision will be checked. If the precision overflows, null will be returned.
  - isCompact
```
public static boolean isCompact(int precision)
```
    Returns whether the decimal value is small enough to be stored in a long.

Back to Flink Website

Class DecimalData

Method Summary

Methods inherited from class java.lang.Object

Method Detail

precision

scale

toBigDecimal

toUnscaledLong

toUnscaledBytes

isCompact

copy

hashCode

compareTo

equals

toString

fromBigDecimal

fromUnscaledLong

fromUnscaledBytes

zero

isCompact

Back to Flink Website