org.greenbytes.http.sfv

Class IntegerItem

java.lang.Object

org.greenbytes.http.sfv.IntegerItem

All Implemented Interfaces:

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

public class IntegerItem
extends Object
implements NumberItem<Long>

Represents an Integer.

See Also:

Section 3.3.1 of RFC 8941

Method Summary

Modifier and Type	Method and Description
Long	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 IntegerItem	valueOf(long value) Creates an IntegerItem instance representing the specified long value.
IntegerItem	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 IntegerItem valueOf(long value)

Creates an IntegerItem instance representing the specified long value.

Parameters:

value - a long value.

Returns:

a IntegerItem representing value.

withParams

public IntegerItem 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<Long>

Specified by:

withParams in interface NumberItem<Long>

Specified by:

withParams in interface Parametrizable<Long>

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<Long>

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<Long>

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<Long>

Returns:

the serialization.

get

public Long get()

Specified by:

get in interface Supplier<Long>

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<Long>

Returns:

the divisor (1 for Integers, 1000 for Decimals)