org.greenbytes.http.sfv

Class DecimalItem

java.lang.Object

org.greenbytes.http.sfv.DecimalItem

All Implemented Interfaces:

LongSupplier, Supplier<BigDecimal>, Item<BigDecimal>, ListElement<BigDecimal>, NumberItem<BigDecimal>, Parametrizable<BigDecimal>, Type<BigDecimal>

public class DecimalItem
extends Object
implements NumberItem<BigDecimal>

Represents a Decimal.

A Decimal - despite it's name - is essentially the same thing as an Integer, but has an implied divisor of 1000 (in other words, a scale of 3). Thus, a value represented as 0.5 in a field value will be internally stored as long with value 500. The only difference to IntegerItem is that get() will return a BigDecimal, and that the implied divisor is taken into account when serializing the value. getAsLong() provides access to the raw value when the overhead of BigDecimal is not needed.

See Also:

Section 3.3.2 of RFC 8941

Method Summary

Modifier and Type	Method and Description
BigDecimal	get()
long	getAsLong()
int	getDivisor() Returns the divisor to be used to obtain the actual numerical value (as opposed to the underlying long value returned by LongSupplier.getAsLong()).
Parameters	getParams() Get the Parameters of this Item.
String	serialize() Serialize.
StringBuilder	serializeTo(StringBuilder sb) Serialize to an existing StringBuilder.
static DecimalItem	valueOf(BigDecimal value) Creates a DecimalItem instance representing the specified BigDecimal value, with potential rounding.
static DecimalItem	valueOf(long value) Creates a DecimalItem instance representing the specified long value, where the implied divisor is 1000.
DecimalItem	withParams(Parameters params) Given an existing Item, return a new instance with the specified Parameters.

Methods inherited from class java.lang.Object

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

Method Detail

valueOf

public static DecimalItem valueOf(long value)

Creates a DecimalItem instance representing the specified long value, where the implied divisor is 1000.

Parameters:

value - a long value.

Returns:

a DecimalItem representing value.

valueOf

public static DecimalItem valueOf(BigDecimal value)

Creates a DecimalItem instance representing the specified BigDecimal value, with potential rounding.

Parameters:

value - a BigDecimal value.

Returns:

a DecimalItem representing value.

withParams

public DecimalItem withParams(Parameters params)

Description copied from interface: Parametrizable

Given an existing Item, return a new instance with the specified Parameters.

Specified by:

withParams in interface Item<BigDecimal>

Specified by:

withParams in interface NumberItem<BigDecimal>

Specified by:

withParams in interface Parametrizable<BigDecimal>

Parameters:

params - Parameters to set (must be non-null)

Returns:

new instance with specified Parameters.

getParams

public Parameters getParams()

Description copied from interface: Parametrizable

Get the Parameters of this Item.

Specified by:

getParams in interface Parametrizable<BigDecimal>

Returns:

the parameters.

serializeTo

public StringBuilder serializeTo(StringBuilder sb)

Description copied from interface: Type

Serialize to an existing StringBuilder.

Specified by:

serializeTo in interface Type<BigDecimal>

Parameters:

sb - where to serialize to

Returns:

the StringBuilder so calls can be chained.

serialize

public String serialize()

Description copied from interface: Type

Serialize.

Specified by:

serialize in interface Type<BigDecimal>

Returns:

the serialization.

get

public BigDecimal get()

Specified by:

get in interface Supplier<BigDecimal>

getAsLong

public long getAsLong()

Specified by:

getAsLong in interface LongSupplier

getDivisor

public int getDivisor()

Description copied from interface: NumberItem

Returns the divisor to be used to obtain the actual numerical value (as opposed to the underlying long value returned by LongSupplier.getAsLong()).

Specified by:

getDivisor in interface NumberItem<BigDecimal>

Returns:

the divisor (1 for Integers, 1000 for Decimals)