Top Description Fields Constructors Methods
com.fasterxml.jackson.databind.node

public Class FloatNode

extends NumericNode
Class Inheritance
Annotations
@SuppressWarnings:serial
Imports
com.fasterxml.jackson.core.JsonGenerator, .JsonParser, .JsonToken, com.fasterxml.jackson.core.io.NumberOutput, com.fasterxml.jackson.databind.SerializerProvider, java.io.IOException, java.math.BigDecimal, .BigInteger
JsonNode implementation for efficiently containing 32-bit `float` values.
Since
2.2

Field Summary

Modifier and TypeField and Description
protected final float
_value

Constructor Summary

AccessConstructor and Description
public
FloatNode(float v)

Method Summary

Modifier and TypeMethod and Description
public String
asText()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.asText.

Method that will return a valid String representation of the container value, if the node is a value node (method isValueNode returns true), otherwise empty String.
public JsonToken
asToken()

Implements abstract com.fasterxml.jackson.databind.node.ValueNode.asToken.

Implements com.fasterxml.jackson.core.TreeNode.asToken.

Method that can be used for efficient type detection when using stream abstraction for traversing nodes.
public BigInteger
bigIntegerValue()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.bigIntegerValue.

Returns integer value for this node (as BigInteger), if and only if this node is numeric (isNumber returns true).
public boolean
canConvertToExactIntegral()

Overrides com.fasterxml.jackson.databind.JsonNode.canConvertToExactIntegral.

Method that can be used to check whether contained value is numeric (returns true for isNumber()) and can be losslessly converted to integral number (specifically, BigInteger but potentially others, see canConvertToInt and canConvertToInt).
public boolean
canConvertToInt()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.canConvertToInt.

Method that can be used to check whether this node is a numeric node (isNumber would return true) AND its value fits within Java's 32-bit signed integer type, int.
public boolean
canConvertToLong()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.canConvertToLong.

Method that can be used to check whether this node is a numeric node (isNumber would return true) AND its value fits within Java's 64-bit signed integer type, long.
public BigDecimal
decimalValue()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.decimalValue.

Returns floating point value for this node (as BigDecimal), if and only if this node is numeric (isNumber returns true).
public double
doubleValue()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.doubleValue.

Returns 64-bit floating point (double) value for this node, if and only if this node is numeric (isNumber returns true).
public boolean
equals(Object
the reference object with which to compare.
o)

Implements abstract com.fasterxml.jackson.databind.JsonNode.equals.

Equality for node objects is defined as full (deep) value equality.
public float
floatValue()

Overrides com.fasterxml.jackson.databind.JsonNode.floatValue.

Returns 32-bit floating value for this node, if and only if this node is numeric (isNumber returns true).
public int
hashCode()

Implements abstract com.fasterxml.jackson.databind.node.BaseJsonNode.hashCode.

Returns a hash code value for the object.
public int
intValue()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.intValue.

Returns integer value for this node, if and only if this node is numeric (isNumber returns true).
public boolean
isFloat()

Overrides com.fasterxml.jackson.databind.JsonNode.isFloat.

public boolean
isFloatingPointNumber()

Overrides com.fasterxml.jackson.databind.JsonNode.isFloatingPointNumber.

public boolean
isNaN()

Overrides com.fasterxml.jackson.databind.node.NumericNode.isNaN.

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

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.longValue.

Returns 64-bit long value for this node, if and only if this node is numeric (isNumber returns true).
public JsonParser.NumberType
numberType()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.numberType.

Implements com.fasterxml.jackson.core.TreeNode.numberType.

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

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.numberValue.

Returns numeric value for this node, if and only if this node is numeric (isNumber returns true); otherwise returns null
public final void
serialize(JsonGenerator g, SerializerProvider provider)

Implements abstract com.fasterxml.jackson.databind.node.BaseJsonNode.serialize.

Implements com.fasterxml.jackson.databind.JsonSerializable.serialize.

Method called to serialize node instances using given generator.
public short
shortValue()

Overrides com.fasterxml.jackson.databind.JsonNode.shortValue.

Returns 16-bit short value for this node, if and only if this node is numeric (isNumber returns true).
public static FloatNode
valueOf(float v)

Inherited from com.fasterxml.jackson.databind.node.NumericNode:
asDoubleasDoubleasIntasIntasLongasLonggetNodeType

Field Detail

_valueback to summary
protected final float _value

Constructor Detail

FloatNodeback to summary
public FloatNode(float v)

Method Detail

asTextback to summary
public String asText()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.asText.

Doc from com.fasterxml.jackson.databind.JsonNode.asText.

Method that will return a valid String representation of the container value, if the node is a value node (method isValueNode returns true), otherwise empty String.

Annotations
@Override
asTokenback to summary
public JsonToken asToken()

Implements abstract com.fasterxml.jackson.databind.node.ValueNode.asToken.

Implements com.fasterxml.jackson.core.TreeNode.asToken.

Doc from com.fasterxml.jackson.databind.node.BaseJsonNode.asToken.

Method that can be used for efficient type detection when using stream abstraction for traversing nodes. Will return the first JsonToken that equivalent stream event would produce (for most nodes there is just one token but for structured/container types multiple)

Returns:JsonToken

Doc from com.fasterxml.jackson.core.TreeNode.asToken.

JsonToken that is most closely associated with the node type

Annotations
@Override
bigIntegerValueback to summary
public BigInteger bigIntegerValue()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.bigIntegerValue.

Doc from com.fasterxml.jackson.databind.JsonNode.bigIntegerValue.

Returns integer value for this node (as BigInteger), if and only if this node is numeric (isNumber returns true). For other types returns BigInteger.ZERO.

Note

In Jackson 2.x MAY throw com.fasterxml.jackson.core.exc.StreamConstraintsException if the scale of the underlying BigDecimal is too large to convert (NOTE: thrown "sneakily" in Jackson 2.x due to API compatibility restrictions)

Returns:BigInteger

BigInteger value this node contains, if numeric node; BigInteger.ZERO for non-number nodes.

Annotations
@Override
canConvertToExactIntegralback to summary
public boolean canConvertToExactIntegral()

Overrides com.fasterxml.jackson.databind.JsonNode.canConvertToExactIntegral.

Doc from com.fasterxml.jackson.databind.JsonNode.canConvertToExactIntegral.

Method that can be used to check whether contained value is numeric (returns true for isNumber()) and can be losslessly converted to integral number (specifically, BigInteger but potentially others, see canConvertToInt and canConvertToInt). Latter part allows floating-point numbers (for which isFloatingPointNumber() returns true) that do not have fractional part. Note that "not-a-number" values of double and float will return false as they can not be converted to matching integral representations.

Returns:boolean

True if the value is an actual number with no fractional part; false for non-numeric types, NaN representations of floating-point numbers, and floating-point numbers with fractional part.

Annotations
@Override
canConvertToIntback to summary
public boolean canConvertToInt()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.canConvertToInt.

Doc from com.fasterxml.jackson.databind.JsonNode.canConvertToInt.

Method that can be used to check whether this node is a numeric node (isNumber would return true) AND its value fits within Java's 32-bit signed integer type, int. Note that floating-point numbers are convertible if the integral part fits without overflow (as per standard Java coercion rules)

Note

this method does not consider possible value type conversion from JSON String into Number; so even if this method returns false, it is possible that asInt could still succeed if node is a JSON String representing integral number, or boolean.

Annotations
@Override
canConvertToLongback to summary
public boolean canConvertToLong()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.canConvertToLong.

Doc from com.fasterxml.jackson.databind.JsonNode.canConvertToLong.

Method that can be used to check whether this node is a numeric node (isNumber would return true) AND its value fits within Java's 64-bit signed integer type, long. Note that floating-point numbers are convertible if the integral part fits without overflow (as per standard Java coercion rules)

Note

this method does not consider possible value type conversion from JSON String into Number; so even if this method returns false, it is possible that asLong could still succeed if node is a JSON String representing integral number, or boolean.

Annotations
@Override
decimalValueback to summary
public BigDecimal decimalValue()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.decimalValue.

Doc from com.fasterxml.jackson.databind.JsonNode.decimalValue.

Returns floating point value for this node (as BigDecimal), if and only if this node is numeric (isNumber returns true). For other types returns BigDecimal.ZERO.

Returns:BigDecimal

BigDecimal value this node contains, if numeric node; BigDecimal.ZERO for non-number nodes.

Annotations
@Override
doubleValueback to summary
public double doubleValue()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.doubleValue.

Doc from com.fasterxml.jackson.databind.JsonNode.doubleValue.

Returns 64-bit floating point (double) value for this node, if and only if this node is numeric (isNumber returns true). For other types returns 0.0. For integer values, conversion is done using coercion; this may result in overflows with BigInteger values.

Returns:double

64-bit double value this node contains, if any; 0.0 for non-number nodes.

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Implements abstract com.fasterxml.jackson.databind.JsonNode.equals.

Doc from com.fasterxml.jackson.databind.JsonNode.equals.

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 java.lang.Object.

Parameters
o:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
floatValueback to summary
public float floatValue()

Overrides com.fasterxml.jackson.databind.JsonNode.floatValue.

Doc from com.fasterxml.jackson.databind.JsonNode.floatValue.

Returns 32-bit floating value for this node, if and only if this node is numeric (isNumber returns true). For other types returns 0.0. For integer values, conversion is done using coercion; this means that an overflow is possible for `long` values

Returns:float

32-bit float value this node contains, if any; 0.0 for non-number nodes.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Implements abstract com.fasterxml.jackson.databind.node.BaseJsonNode.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
intValueback to summary
public int intValue()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.intValue.

Doc from com.fasterxml.jackson.databind.JsonNode.intValue.

Returns integer value for this node, if and only if this node is numeric (isNumber returns true). For other types returns 0. For floating-point numbers, value is truncated using default Java coercion, similar to how cast from double to int operates.

Returns:int

Integer value this node contains, if any; 0 for non-number nodes.

Annotations
@Override
isFloatback to summary
public boolean isFloat()

Overrides com.fasterxml.jackson.databind.JsonNode.isFloat.

Annotations
@Override
isFloatingPointNumberback to summary
public boolean isFloatingPointNumber()

Overrides com.fasterxml.jackson.databind.JsonNode.isFloatingPointNumber.

Returns:boolean

Doc from com.fasterxml.jackson.databind.JsonNode.isFloatingPointNumber.

True if this node represents a non-integral numeric JSON value

Annotations
@Override
isNaNback to summary
public boolean isNaN()

Overrides com.fasterxml.jackson.databind.node.NumericNode.isNaN.

Doc from com.fasterxml.jackson.databind.node.NumericNode.isNaN.

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

Annotations
@Override
longValueback to summary
public long longValue()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.longValue.

Doc from com.fasterxml.jackson.databind.JsonNode.longValue.

Returns 64-bit long value for this node, if and only if this node is numeric (isNumber returns true). For other types returns 0. For floating-point numbers, value is truncated using default Java coercion, similar to how cast from double to long operates.

Returns:long

Long value this node contains, if any; 0 for non-number nodes.

Annotations
@Override
numberTypeback to summary
public JsonParser.NumberType numberType()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.numberType.

Implements com.fasterxml.jackson.core.TreeNode.numberType.

Doc from com.fasterxml.jackson.databind.node.BaseJsonNode.numberType.

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

Returns:JsonParser.NumberType

Doc from com.fasterxml.jackson.core.TreeNode.numberType.

Type of number contained, if any; or null if node does not contain numeric value.

Annotations
@Override
numberValueback to summary
public Number numberValue()

Implements abstract com.fasterxml.jackson.databind.node.NumericNode.numberValue.

Doc from com.fasterxml.jackson.databind.JsonNode.numberValue.

Returns numeric value for this node, if and only if this node is numeric (isNumber returns true); otherwise returns null

Returns:Number

Number value this node contains, if any (null for non-number nodes).

Annotations
@Override
serializeback to summary
public final void serialize(JsonGenerator g, SerializerProvider provider) throws IOException

Implements abstract com.fasterxml.jackson.databind.node.BaseJsonNode.serialize.

Implements com.fasterxml.jackson.databind.JsonSerializable.serialize.

Doc from com.fasterxml.jackson.databind.node.BaseJsonNode.serialize.

Method called to serialize node instances using given generator.

Annotations
@Override
shortValueback to summary
public short shortValue()

Overrides com.fasterxml.jackson.databind.JsonNode.shortValue.

Doc from com.fasterxml.jackson.databind.JsonNode.shortValue.

Returns 16-bit short value for this node, if and only if this node is numeric (isNumber returns true). For other types returns 0. For floating-point numbers, value is truncated using default Java coercion, similar to how cast from double to short operates.

Returns:short

Short value this node contains, if any; 0 for non-number nodes.

Annotations
@Override
valueOfback to summary
public static FloatNode valueOf(float v)