Module tools.jackson.databind

Package tools.jackson.databind.node

Class DecimalNode

java.lang.Object

tools.jackson.databind.JacksonSerializable.Base

tools.jackson.databind.JsonNode

tools.jackson.databind.node.BaseJsonNode

tools.jackson.databind.node.ValueNode

tools.jackson.databind.node.NumericNode

tools.jackson.databind.node.NumericFPNode

tools.jackson.databind.node.DecimalNode

All Implemented Interfaces:

Serializable, Iterable<JsonNode>, TreeNode, JacksonSerializable

public class DecimalNode
extends NumericFPNode

Numeric node that contains values that do not fit in simple floating point (double) values.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class tools.jackson.databind.JsonNode

JsonNode.OverwriteMode

Nested classes/interfaces inherited from interface tools.jackson.databind.JacksonSerializable

JacksonSerializable.Base

Field Summary

Fields

Modifier and Type	Field	Description
protected final BigDecimal	_value
static final DecimalNode	ZERO

Fields inherited from class tools.jackson.databind.node.ValueNode

BD_MAX_INTEGER, BD_MAX_LONG, BD_MAX_SHORT, BD_MIN_INTEGER, BD_MIN_LONG, BD_MIN_SHORT, BI_MAX_INTEGER, BI_MAX_LONG, BI_MAX_SHORT, BI_MIN_INTEGER, BI_MIN_LONG, BI_MIN_SHORT, MISSING

Fields inherited from class tools.jackson.databind.node.BaseJsonNode

OPT_FALSE, OPT_TRUE

Constructor Summary

Constructors

Constructor	Description
DecimalNode(BigDecimal v)

Method Summary

Modifier and Type	Method	Description
protected BigInteger	_asBigIntegerValueUnchecked()	Method for sub-classes to implement; returns the underlying value as a BigInteger without any checks (wrt NaN), so caller must ensure validity prior to calling
protected BigDecimal	_asDecimalValueUnchecked()	Method for sub-classes to implement; returns the underlying value as a BigDecimal without any checks (wrt NaN), so caller must ensure validity prior to calling
int	_asIntValueUnchecked()	Method for sub-classes to implement; returns the underlying value as a int without any checks (wrt NaN or value range), so caller must ensure validity prior to calling
long	_asLongValueUnchecked()	Method for sub-classes to implement; returns the underlying value as a long without any checks (wrt NaN or value range), so caller must ensure validity prior to calling
short	_asShortValueUnchecked()	Method for sub-classes to implement; returns the underlying value as a short without any checks (wrt NaN or value range), so caller must ensure validity prior to calling
String	_asString()	Method sub-classes should override if they can produce String values via BaseJsonNode.asString() -- if not, return null (in which case appropriate error will be thrown or default value returned).
BigDecimal	asDecimal()	Method that will try to access value of this node as a BigDecimal: but if node value cannot be expressed exactly as a BigDecimal, a JsonNodeException will be thrown.
BigDecimal	asDecimal(BigDecimal defaultValue)	Method similar to JsonNode.asDecimal(), but that will return defaultValue if this node cannot be coerced to Java BigDecimal.
Optional<BigDecimal>	asDecimalOpt()	Method similar to JsonNode.asDecimal(), but that will return empty Optional (Optional.empty()) if this node cannot be coerced to BigDecimal.
double	asDouble()	Method similar to JsonNode.doubleValue() but in addition to coercing Number values will also try coerce couple of additional types: JSON String that represents JSON Numbers ("stringified" numbers) JSON Null (converted to 0.0d) POJO nodes that contain Number values
double	asDouble(double defaultValue)	Method similar to JsonNode.asDouble(), but that will return defaultValue if this node cannot be coerced to double.
OptionalDouble	asDoubleOpt()	Method similar to JsonNode.asDouble(), but that will return (OptionalDouble.empty()) if this node cannot be coerced to double.
float	asFloat()	Method similar to JsonNode.floatValue() but in addition to coercing Number values will also try coerce couple of additional types: JSON String that represents JSON Numbers ("stringified" numbers) JSON Null (converted to 0.0f) POJO nodes that contain Number values
float	asFloat(float defaultValue)	Method similar to JsonNode.asFloat(), but that will return defaultValue if this node cannot be coerced to float.
Optional<Float>	asFloatOpt()	Method similar to JsonNode.asFloat(), but that will return (Optional.empty()) if this node cannot be coerced to float.
BigDecimal	decimalValue()	Method that will try to access value of this node as a Java BigDecimal: but if node value cannot be expressed exactly as a BigDecimal, a JsonNodeException will be thrown.
BigDecimal	decimalValue(BigDecimal defaultValue)	Method similar to JsonNode.decimalValue(), but that will return defaultValue if this node cannot be coerced to Java BigDecimal.
Optional<BigDecimal>	decimalValueOpt()	Method similar to JsonNode.decimalValue(), but that will return empty Optional (Optional.empty()) if this node cannot be coerced to BigDecimal.
double	doubleValue()	Method that will try to access value of this node as a double: but if node value cannot be expressed exactly as a double, a JsonNodeException will be thrown.
double	doubleValue(double defaultValue)	Method similar to JsonNode.doubleValue(), but that will return specified defaultValue if this node cannot be converted to double.
OptionalDouble	doubleValueOpt()	Method similar to JsonNode.doubleValue(), but that will return empty OptionalLong (OptionalDouble.empty()) if this node cannot be converted to Java double.
boolean	equals(Object o)	Equality for node objects is defined as full (deep) value equality.
float	floatValue()	Method that will try to access value of this node as a Java float: but if node value cannot be expressed exactly as a float, a JsonNodeException will be thrown.
float	floatValue(float defaultValue)	Method similar to JsonNode.floatValue(), but that will return specified defaultValue if this node cannot be converted to float.
Optional<Float>	floatValueOpt()	Method similar to JsonNode.floatValue(), but that will return empty Optional<Float> (Optional.empty()) if this node cannot be converted to Java float.
boolean	hasFractionalPart()	Convenience method for checking whether this node is a NumericFPNode that contains non-zero fractional part (as opposed to only integer part).
int	hashCode()
boolean	inIntRange()	Method that can be used to determine whether this numeric value's in part fits within Java 32-bitint type.
boolean	inLongRange()	Method that can be used to determine whether this numeric value's in part fits within Java 64-bit long type.
boolean	inShortRange()	Method that can be used to determine whether this numeric value's in part fits within Java 16-bit short type.
boolean	isBigDecimal()
boolean	isNaN()	Convenience method for checking whether this node is a FloatNode or DoubleNode that contains "not-a-number" (NaN) value.
JsonParser.NumberType	numberType()	Returns code that identifies type of underlying numeric value, if (and only if) node is a number node.
Number	numberValue()	Method that will try to access value of this node as Number that accurately represents its value, if (and only if) this is a number node (returns true for JsonNode.isNumber()).
final void	serialize(JsonGenerator g, SerializationContext provider)	Method called to serialize node instances using given generator.
static DecimalNode	valueOf(BigDecimal d)

Methods inherited from class tools.jackson.databind.node.NumericFPNode

asBigInteger, asBigInteger, asBigIntegerOpt, asInt, asInt, asIntOpt, asLong, asLong, asLongOpt, asShort, asShort, asShortOpt, asToken, bigIntegerValue, bigIntegerValue, bigIntegerValueOpt, canConvertToExactIntegral, canConvertToInt, canConvertToLong, canConvertToShort, intValue, intValue, intValueOpt, isFloatingPointNumber, longValue, longValue, longValueOpt, shortValue, shortValue, shortValueOpt

Methods inherited from class tools.jackson.databind.node.NumericNode

_valueDesc, deepCopy, getNodeType

Methods inherited from class tools.jackson.databind.node.ValueNode

_at, findParent, findParents, findValue, findValues, findValuesAsString, get, get, has, has, hasNonNull, hasNonNull, isEmpty, path, path, serializeWithType

Methods inherited from class tools.jackson.databind.node.BaseJsonNode

_asBoolean, _jsonPointerIfValid, _reportBigDecimalCoercionNaNFail, _reportBigIntegerCoercionFractionFail, _reportBigIntegerCoercionNaNFail, _reportCoercionFail, _reportDoubleCoercionRangeFail, _reportFloatCoercionRangeFail, _reportIntCoercionFractionFail, _reportIntCoercionNaNFail, _reportIntCoercionRangeFail, _reportLongCoercionFractionFail, _reportLongCoercionNaNFail, _reportLongCoercionRangeFail, _reportShortCoercionFractionFail, _reportShortCoercionRangeFail, _reportWrongNodeType, _withArray, _withObject, _withXxxMayReplace, _withXxxVerifyReplace, asBoolean, asBoolean, asBooleanOpt, asString, asString, asStringOpt, binaryValue, booleanValue, booleanValue, booleanValueOpt, findPath, isEmbeddedValue, isMissingNode, required, required, stringValue, stringValue, stringValueOpt, toPrettyString, toString, traverse, withArray, withObject

Methods inherited from class tools.jackson.databind.JsonNode

_reportRequiredViolation, _reportUnsupportedOperation, _this, asOptional, asText, asText, at, at, equals, findParents, findValues, findValuesAsString, forEachEntry, isArray, isBigInteger, isBinary, isBoolean, isContainer, isDouble, isFloat, isInt, isIntegralNumber, isLong, isNull, isNumber, isObject, isPojo, isShort, isString, isTextual, isValueNode, iterator, optional, optional, properties, propertyNames, propertyStream, require, requiredAt, requiredAt, requireNonNull, size, spliterator, textValue, values, valueStream, withArray, withArray, withArray, withArrayProperty, withObject, withObject, withObject, withObjectProperty

Methods inherited from class tools.jackson.databind.JacksonSerializable.Base

isEmpty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach

Field Details

ZERO

public static final DecimalNode ZERO

_value

protected final BigDecimal _value

Constructor Details

DecimalNode

public DecimalNode(BigDecimal v)

Method Details

valueOf

public static DecimalNode valueOf(BigDecimal d)

numberType

public JsonParser.NumberType numberType()

Description copied from class: BaseJsonNode

Returns code that identifies type of underlying numeric value, if (and only if) node is a number node.

Specified by:

numberType in interface TreeNode

Specified by:

numberType in class NumericNode

isBigDecimal

public boolean isBigDecimal()

Overrides:

isBigDecimal in class JsonNode

isNaN

public boolean isNaN()

Description copied from class: NumericNode

Convenience method for checking whether this node is a FloatNode or DoubleNode that contains "not-a-number" (NaN) value.

Specified by:

isNaN in class NumericNode

_asString

public String _asString()

Description copied from class: BaseJsonNode

Method sub-classes should override if they can produce String values via BaseJsonNode.asString() -- if not, return null (in which case appropriate error will be thrown or default value returned).

Specified by:

_asString in class NumericNode

Returns:

Coerced value if possible; otherwise null to indicate this node cannot be coerced.

numberValue

public Number numberValue()

Description copied from class: JsonNode

Method that will try to access value of this node as Number that accurately represents its value, if (and only if) this is a number node (returns true for JsonNode.isNumber()). If this node is NOT a number node, a JsonNodeException will be thrown.

Specified by:

numberValue in class NumericNode

Returns:

Number value this node contains, if numeric node

floatValue

public float floatValue()

Description copied from class: JsonNode

Method that will try to access value of this node as a Java float: but if node value cannot be expressed exactly as a float, a JsonNodeException will be thrown. Access works for following cases:

• JSON Floating-point values that fit in Java 32-bit double range
• JSON Integer values that fit in Java 32-bit double range

Specified by:

floatValue in class NumericNode

Returns:

Float value this node represents, if possible to accurately represent

floatValue

public float floatValue(float defaultValue)

Description copied from class: JsonNode

Method similar to JsonNode.floatValue(), but that will return specified defaultValue if this node cannot be converted to float.

Specified by:

floatValue in class NumericNode

Parameters:

defaultValue - Value to return if this node cannot be converted to float

Returns:

float value this node represents, if possible to accurately represent; defaultValue otherwise

floatValueOpt

public Optional<Float> floatValueOpt()

Description copied from class: JsonNode

Method similar to JsonNode.floatValue(), but that will return empty Optional<Float> (Optional.empty()) if this node cannot be converted to Java float.

Specified by:

floatValueOpt in class NumericNode

Returns:

Java float value this node represents, as Optional<Float>, if possible to accurately represent; Optional.empty() otherwise

asFloat

public float asFloat()

Description copied from class: JsonNode

Method similar to JsonNode.floatValue() but in addition to coercing Number values will also try coerce couple of additional types:

• JSON String that represents JSON Numbers ("stringified" numbers)
• JSON Null (converted to 0.0f)
• POJO nodes that contain Number values

Specified by:

asFloat in class NumericNode

Returns:

float value this node represents, if possible to accurately represent

asFloat

public float asFloat(float defaultValue)

Description copied from class: JsonNode

Method similar to JsonNode.asFloat(), but that will return defaultValue if this node cannot be coerced to float.

Specified by:

asFloat in class NumericNode

Returns:

float value this node represents, if possible to accurately represent; defaultValue otherwise

asFloatOpt

public Optional<Float> asFloatOpt()

Description copied from class: JsonNode

Method similar to JsonNode.asFloat(), but that will return (Optional.empty()) if this node cannot be coerced to float.

Specified by:

asFloatOpt in class NumericNode

Returns:

Optional<Float> value this node represents, if possible to accurately represent; Optional.empty() otherwise

doubleValue

public double doubleValue()

Description copied from class: JsonNode

Method that will try to access value of this node as a double: but if node value cannot be expressed exactly as a double, a JsonNodeException will be thrown. Access works for following cases:

• JSON Floating-point values that fit in Java 64-bit double range
• JSON Integer values that fit in Java 64-bit double range

NOTE: for more lenient conversions, use JsonNode.asDouble()

Specified by:

doubleValue in class NumericNode

Returns:

Double value this node represents, if possible to accurately represent

doubleValue

public double doubleValue(double defaultValue)

Description copied from class: JsonNode

Method similar to JsonNode.doubleValue(), but that will return specified defaultValue if this node cannot be converted to double.

Specified by:

doubleValue in class NumericNode

Parameters:

defaultValue - Value to return if this node cannot be converted to double

Returns:

double value this node represents, if possible to accurately represent; defaultValue otherwise

doubleValueOpt

public OptionalDouble doubleValueOpt()

Description copied from class: JsonNode

Method similar to JsonNode.doubleValue(), but that will return empty OptionalLong (OptionalDouble.empty()) if this node cannot be converted to Java double.

Specified by:

doubleValueOpt in class NumericNode

Returns:

Java double value this node represents, as OptionalDouble, if possible to accurately represent; OptionalDouble.empty() otherwise

asDouble

public double asDouble()

Description copied from class: JsonNode

Method similar to JsonNode.doubleValue() but in addition to coercing Number values will also try coerce couple of additional types:

• JSON String that represents JSON Numbers ("stringified" numbers)
• JSON Null (converted to 0.0d)
• POJO nodes that contain Number values

Specified by:

asDouble in class NumericNode

Returns:

double value this node represents, if possible to accurately represent

asDouble

public double asDouble(double defaultValue)

Description copied from class: JsonNode

Method similar to JsonNode.asDouble(), but that will return defaultValue if this node cannot be coerced to double.

Specified by:

asDouble in class NumericNode

Returns:

double value this node represents, if possible to accurately represent; defaultValue otherwise

asDoubleOpt

public OptionalDouble asDoubleOpt()

Description copied from class: JsonNode

Method similar to JsonNode.asDouble(), but that will return (OptionalDouble.empty()) if this node cannot be coerced to double.

Specified by:

asDoubleOpt in class NumericNode

Returns:

OptionalDouble value this node represents, if possible to accurately represent; OptionalDouble.empty() otherwise

decimalValue

public BigDecimal decimalValue()

Description copied from class: JsonNode

Method that will try to access value of this node as a Java BigDecimal: but if node value cannot be expressed exactly as a BigDecimal, a JsonNodeException will be thrown. Access works for following cases:

• All JSON Number values

NOTE: for more lenient conversions, use JsonNode.asDecimal()

Overrides:

decimalValue in class NumericFPNode

Returns:

BigDecimal value this node represents, if possible to accurately represent

decimalValue

public BigDecimal decimalValue(BigDecimal defaultValue)

Description copied from class: JsonNode

Method similar to JsonNode.decimalValue(), but that will return defaultValue if this node cannot be coerced to Java BigDecimal.

Overrides:

decimalValue in class NumericFPNode

Returns:

BigDecimal value this node represents, if possible to accurately represent; defaultValue otherwise

decimalValueOpt

public Optional<BigDecimal> decimalValueOpt()

Description copied from class: JsonNode

Method similar to JsonNode.decimalValue(), but that will return empty Optional (Optional.empty()) if this node cannot be coerced to BigDecimal.

Overrides:

decimalValueOpt in class NumericFPNode

Returns:

Java BigDecimal value this node represents, as Optional<BigDecimal>, if possible to accurately represent; Optional.empty() otherwise

asDecimal

public BigDecimal asDecimal()

Description copied from class: JsonNode

Method that will try to access value of this node as a BigDecimal: but if node value cannot be expressed exactly as a BigDecimal, a JsonNodeException will be thrown. Access works for following cases:

• JSON Floating-point values (but not "NaN" or "Infinity")
• JSON Integer values
• JSON String that represents JSON Numbers ("stringified" numbers)
• JSON Null (converted to BigDecimal.ZERO))
• POJO nodes that contain Number values

Overrides:

asDecimal in class NumericFPNode

Returns:

BigDecimal value this node represents, if possible to accurately represent

asDecimal

public BigDecimal asDecimal(BigDecimal defaultValue)

Description copied from class: JsonNode

Method similar to JsonNode.asDecimal(), but that will return defaultValue if this node cannot be coerced to Java BigDecimal.

Overrides:

asDecimal in class NumericFPNode

Returns:

BigDecimal value this node represents, if possible to accurately represent; defaultValue otherwise

asDecimalOpt

public Optional<BigDecimal> asDecimalOpt()

Description copied from class: JsonNode

Method similar to JsonNode.asDecimal(), but that will return empty Optional (Optional.empty()) if this node cannot be coerced to BigDecimal.

Overrides:

asDecimalOpt in class NumericFPNode

Returns:

Java BigDecimal value this node represents, as Optional<BigDecimal>, if possible to accurately represent; Optional.empty() otherwise

_asShortValueUnchecked

public short _asShortValueUnchecked()

Description copied from class: NumericNode

Method for sub-classes to implement; returns the underlying value as a short without any checks (wrt NaN or value range), so caller must ensure validity prior to calling

Specified by:

_asShortValueUnchecked in class NumericNode

_asIntValueUnchecked

public int _asIntValueUnchecked()

Description copied from class: NumericNode

Method for sub-classes to implement; returns the underlying value as a int without any checks (wrt NaN or value range), so caller must ensure validity prior to calling

Specified by:

_asIntValueUnchecked in class NumericNode

_asLongValueUnchecked

public long _asLongValueUnchecked()

Description copied from class: NumericNode

Method for sub-classes to implement; returns the underlying value as a long without any checks (wrt NaN or value range), so caller must ensure validity prior to calling

Specified by:

_asLongValueUnchecked in class NumericNode

_asBigIntegerValueUnchecked

protected BigInteger _asBigIntegerValueUnchecked()

Description copied from class: NumericFPNode

Method for sub-classes to implement; returns the underlying value as a BigInteger without any checks (wrt NaN), so caller must ensure validity prior to calling

Specified by:

_asBigIntegerValueUnchecked in class NumericFPNode

_asDecimalValueUnchecked

protected BigDecimal _asDecimalValueUnchecked()

Description copied from class: NumericFPNode

Method for sub-classes to implement; returns the underlying value as a BigDecimal without any checks (wrt NaN), so caller must ensure validity prior to calling

Specified by:

_asDecimalValueUnchecked in class NumericFPNode

hasFractionalPart

public boolean hasFractionalPart()

Description copied from class: NumericNode

Convenience method for checking whether this node is a NumericFPNode that contains non-zero fractional part (as opposed to only integer part). Always returns false for integral NumericNodes (that is, s).

Specified by:

hasFractionalPart in class NumericNode

inShortRange

public boolean inShortRange()

Description copied from class: NumericNode

Method that can be used to determine whether this numeric value's in part fits within Java 16-bit short type.

Specified by:

inShortRange in class NumericNode

inIntRange

public boolean inIntRange()

Description copied from class: NumericNode

Method that can be used to determine whether this numeric value's in part fits within Java 32-bitint type.

Specified by:

inIntRange in class NumericNode

inLongRange

public boolean inLongRange()

Description copied from class: NumericNode

Method that can be used to determine whether this numeric value's in part fits within Java 64-bit long type.

Specified by:

inLongRange in class NumericNode

serialize

public final void serialize(JsonGenerator g,
 SerializationContext provider)
                     throws JacksonException

Description copied from class: BaseJsonNode

Method called to serialize node instances using given generator.

Specified by:

serialize in interface JacksonSerializable

Specified by:

serialize in class BaseJsonNode

Throws:

JacksonException

equals

public boolean equals(Object o)

Description copied from class: JsonNode

Equality for node objects is defined as full (deep) value equality. This means that it is possible to compare complete JSON trees for equality by comparing equality of root nodes.

Note: marked as abstract to ensure all implementation classes define it properly and not rely on definition from Object.

Specified by:

equals in class JsonNode

hashCode

public int hashCode()

Specified by:

hashCode in class BaseJsonNode