com.fasterxml.jackson.databind.node

Class POJONode

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializable.Base

com.fasterxml.jackson.databind.JsonNode

com.fasterxml.jackson.databind.node.BaseJsonNode

com.fasterxml.jackson.databind.node.ValueNode

com.fasterxml.jackson.databind.node.POJONode

All Implemented Interfaces:

TreeNode, JsonSerializable, java.lang.Iterable<JsonNode>

public class POJONode
extends ValueNode

Value node that contains a wrapped POJO, to be serialized as a JSON constructed through data mapping (usually done by calling ObjectMapper).

Nested Class Summary

Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable

JsonSerializable.Base

Constructor Summary

Constructors

Constructor and Description
POJONode(java.lang.Object v)

Method Summary

Modifier and Type	Method and Description
boolean	asBoolean(boolean defaultValue) Method that will try to convert value of this node to a Java boolean.
double	asDouble(double defaultValue) Method that will try to convert value of this node to a Java double.
int	asInt(int defaultValue) Method that will try to convert value of this node to a Java int.
long	asLong(long defaultValue) Method that will try to convert value of this node to a Java long.
java.lang.String	asText() Method that will return a valid String representation of the container value, if the node is a value node (method JsonNode.isValueNode() returns true), otherwise empty String.
java.lang.String	asText(java.lang.String defaultValue) Method similar to JsonNode.asText(), except that it will return defaultValue in cases where null value would be returned; either for missing nodes (trying to access missing property, or element at invalid item for array) or explicit nulls.
JsonToken	asToken() Method that can be used for efficient type detection when using stream abstraction for traversing nodes.
byte[]	binaryValue() As it is possible that some implementations embed byte[] as POJONode (despite optimal being BinaryNode), let's add support for exposing binary data here too.
boolean	equals(java.lang.Object o) Equality for node objects is defined as full (deep) value equality.
JsonNodeType	getNodeType() Return the type of this node
java.lang.Object	getPojo() Method that can be used to access the POJO this node wraps.
int	hashCode()
void	serialize(JsonGenerator gen, SerializerProvider ctxt) Method called to serialize node instances using given generator.
java.lang.String	toString() Method that will produce developer-readable representation of the node; which may or may not be as valid JSON.

Methods inherited from class com.fasterxml.jackson.databind.node.ValueNode

deepCopy, findParent, findParents, findValue, findValues, findValuesAsText, get, get, has, has, hasNonNull, hasNonNull, path, path, serializeWithType

Methods inherited from class com.fasterxml.jackson.databind.node.BaseJsonNode

findPath, numberType, traverse, traverse

Methods inherited from class com.fasterxml.jackson.databind.JsonNode

asBoolean, asDouble, asInt, asLong, at, at, bigIntegerValue, booleanValue, canConvertToInt, canConvertToLong, decimalValue, doubleValue, elements, equals, fieldNames, fields, findParents, findValues, findValuesAsText, floatValue, intValue, isArray, isBigDecimal, isBigInteger, isBinary, isBoolean, isContainerNode, isDouble, isFloat, isFloatingPointNumber, isInt, isIntegralNumber, isLong, isMissingNode, isNull, isNumber, isObject, isPojo, isShort, isTextual, isValueNode, iterator, longValue, numberValue, shortValue, size, textValue, with, withArray

Methods inherited from class com.fasterxml.jackson.databind.JsonSerializable.Base

isEmpty

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

POJONode

public POJONode(java.lang.Object v)

Method Detail

getNodeType

public JsonNodeType getNodeType()

Description copied from class: JsonNode

Return the type of this node

Specified by:

getNodeType in class JsonNode

Returns:

the node type as a JsonNodeType enum value

asToken

public JsonToken asToken()

Description copied from class: BaseJsonNode

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)

Specified by:

asToken in interface TreeNode

Specified by:

asToken in class ValueNode

binaryValue

public byte[] binaryValue()
                   throws java.io.IOException

As it is possible that some implementations embed byte[] as POJONode (despite optimal being BinaryNode), let's add support for exposing binary data here too.

Overrides:

binaryValue in class JsonNode

Returns:

Binary data this node contains, iff it is a binary node; null otherwise

Throws:

java.io.IOException

asText

public java.lang.String asText()

Description copied from class: JsonNode

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

Specified by:

asText in class JsonNode

asText

public java.lang.String asText(java.lang.String defaultValue)

Description copied from class: JsonNode

Method similar to JsonNode.asText(), except that it will return defaultValue in cases where null value would be returned; either for missing nodes (trying to access missing property, or element at invalid item for array) or explicit nulls.

Overrides:

asText in class JsonNode

asBoolean

public boolean asBoolean(boolean defaultValue)

Description copied from class: JsonNode

Method that will try to convert value of this node to a Java boolean. JSON booleans map naturally; integer numbers other than 0 map to true, and 0 maps to false and Strings 'true' and 'false' map to corresponding values.

If representation cannot be converted to a boolean value (including structured types like Objects and Arrays), specified defaultValue will be returned; no exceptions are thrown.

Overrides:

asBoolean in class JsonNode

asInt

public int asInt(int defaultValue)

Description copied from class: JsonNode

Method that will try to convert value of this node to a Java int. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

If representation cannot be converted to an int (including structured types like Objects and Arrays), specified defaultValue will be returned; no exceptions are thrown.

Overrides:

asInt in class JsonNode

asLong

public long asLong(long defaultValue)

Description copied from class: JsonNode

Method that will try to convert value of this node to a Java long. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

If representation cannot be converted to an long (including structured types like Objects and Arrays), specified defaultValue will be returned; no exceptions are thrown.

Overrides:

asLong in class JsonNode

asDouble

public double asDouble(double defaultValue)

Description copied from class: JsonNode

Method that will try to convert value of this node to a Java double. Numbers are coerced using default Java rules; booleans convert to 0.0 (false) and 1.0 (true), and Strings are parsed using default Java language integer parsing rules.

If representation cannot be converted to an int (including structured types like Objects and Arrays), specified defaultValue will be returned; no exceptions are thrown.

Overrides:

asDouble in class JsonNode

serialize

public final void serialize(JsonGenerator gen,
                            SerializerProvider ctxt)
                     throws java.io.IOException

Description copied from class: BaseJsonNode

Method called to serialize node instances using given generator.

Specified by:

serialize in interface JsonSerializable

Specified by:

serialize in class BaseJsonNode

Throws:

java.io.IOException

getPojo

public java.lang.Object getPojo()

Method that can be used to access the POJO this node wraps.

equals

public boolean equals(java.lang.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

toString

public java.lang.String toString()

Description copied from class: JsonNode

Method that will produce developer-readable representation of the node; which may or may not be as valid JSON. If you want valid JSON output (or output formatted using one of other Jackson supported data formats) make sure to use ObjectMapper or ObjectWriter to serialize an instance, for example:

   String json = objectMapper.writeValueAsString(rootNode);

Note: method defined as abstract to ensure all implementation classes explicitly implement method, instead of relying on Object.toString() definition.

Overrides:

toString in class ValueNode