Class MissingNode
- 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.MissingNode
-
- All Implemented Interfaces:
com.fasterxml.jackson.core.TreeNode,JsonSerializable,Serializable,Iterable<JsonNode>
public final class MissingNode extends ValueNode
This singleton node class is generated to denote "missing nodes" along paths that do not exist. For example, if a path via element of an array is requested for an element outside range of elements in the array; or for a non-array value, result will be reference to this node.In most respects this placeholder node will act as
NullNode; for example, for purposes of value conversions, value is considered to be null and represented as value zero when used for numeric conversions.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable
JsonSerializable.Base
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedMissingNode()NOTE: visibility raised to `protected` in 2.9.3 to allow custom subtypes (which may not be greatest idea ever to have but was requested)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringasText()Method that will return a valid String representation of the container value, if the node is a value node (methodJsonNode.isValueNode()returns true), otherwise empty String.StringasText(String defaultValue)Method similar toJsonNode.asText(), except that it will returndefaultValuein 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.com.fasterxml.jackson.core.JsonTokenasToken()Method that can be used for efficient type detection when using stream abstraction for traversing nodes.<T extends JsonNode>
TdeepCopy()All current value nodes are immutable, so we can just return them as is.booleanequals(Object o)Equality for node objects is defined as full (deep) value equality.static MissingNodegetInstance()JsonNodeTypegetNodeType()Return the type of this nodeinthashCode()booleanisMissingNode()protected ObjectreadResolve()JsonNoderequire()Method that may be called to verify thatthisnode is NOT so-called "missing node": that is, one for whichJsonNode.isMissingNode()returnstrue.JsonNoderequireNonNull()Method that may be called to verify thatthisnode is neither so-called "missing node" (that is, one for whichJsonNode.isMissingNode()returnstrue) nor "null node" (one for whichJsonNode.isNull()returnstrue).voidserialize(com.fasterxml.jackson.core.JsonGenerator g, SerializerProvider provider)Method called to serialize node instances using given generator.voidserializeWithType(com.fasterxml.jackson.core.JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer)Type information is needed, even if JsonNode instances are "plain" JSON, since they may be mixed with other types.StringtoPrettyString()Alternative toJsonNode.toString()that will serialize this node using Jackson default pretty-printer.StringtoString()Method that will produce (as of Jackson 2.10) valid JSON using default settings of databind, as String.-
Methods inherited from class com.fasterxml.jackson.databind.node.ValueNode
_at, findParent, findParents, findValue, findValues, findValuesAsText, get, get, has, has, hasNonNull, hasNonNull, isEmpty, path, path
-
Methods inherited from class com.fasterxml.jackson.databind.node.BaseJsonNode
findPath, numberType, required, required, traverse, traverse
-
Methods inherited from class com.fasterxml.jackson.databind.JsonNode
_reportRequiredViolation, _this, asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, at, at, bigIntegerValue, binaryValue, 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, isNull, isNumber, isObject, isPojo, isShort, isTextual, isValueNode, iterator, longValue, numberValue, requiredAt, requiredAt, shortValue, size, textValue, with, withArray
-
Methods inherited from class com.fasterxml.jackson.databind.JsonSerializable.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, spliterator
-
-
-
-
Method Detail
-
readResolve
protected Object readResolve()
-
isMissingNode
public boolean isMissingNode()
- Specified by:
isMissingNodein interfacecom.fasterxml.jackson.core.TreeNode- Overrides:
isMissingNodein classJsonNode
-
deepCopy
public <T extends JsonNode> T deepCopy()
Description copied from class:ValueNodeAll current value nodes are immutable, so we can just return them as is.
-
getInstance
public static MissingNode getInstance()
-
getNodeType
public JsonNodeType getNodeType()
Description copied from class:JsonNodeReturn the type of this node- Specified by:
getNodeTypein classJsonNode- Returns:
- the node type as a
JsonNodeTypeenum value
-
asToken
public com.fasterxml.jackson.core.JsonToken asToken()
Description copied from class:BaseJsonNodeMethod that can be used for efficient type detection when using stream abstraction for traversing nodes. Will return the firstJsonTokenthat equivalent stream event would produce (for most nodes there is just one token but for structured/container types multiple)
-
asText
public String asText()
Description copied from class:JsonNodeMethod that will return a valid String representation of the container value, if the node is a value node (methodJsonNode.isValueNode()returns true), otherwise empty String.
-
asText
public String asText(String defaultValue)
Description copied from class:JsonNodeMethod similar toJsonNode.asText(), except that it will returndefaultValuein 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.
-
serialize
public final void serialize(com.fasterxml.jackson.core.JsonGenerator g, SerializerProvider provider) throws IOException, com.fasterxml.jackson.core.JsonProcessingExceptionDescription copied from class:BaseJsonNodeMethod called to serialize node instances using given generator.- Specified by:
serializein interfaceJsonSerializable- Specified by:
serializein classBaseJsonNode- Throws:
IOExceptioncom.fasterxml.jackson.core.JsonProcessingException
-
serializeWithType
public void serializeWithType(com.fasterxml.jackson.core.JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws IOException, com.fasterxml.jackson.core.JsonProcessingExceptionDescription copied from class:BaseJsonNodeType information is needed, even if JsonNode instances are "plain" JSON, since they may be mixed with other types.- Specified by:
serializeWithTypein interfaceJsonSerializable- Overrides:
serializeWithTypein classValueNode- Throws:
IOExceptioncom.fasterxml.jackson.core.JsonProcessingException
-
require
public JsonNode require()
Description copied from class:JsonNodeMethod that may be called to verify thatthisnode is NOT so-called "missing node": that is, one for whichJsonNode.isMissingNode()returnstrue. If not missing node,thisis returned to allow chaining; otherwiseIllegalArgumentExceptionis thrown.
-
requireNonNull
public JsonNode requireNonNull()
Description copied from class:JsonNodeMethod that may be called to verify thatthisnode is neither so-called "missing node" (that is, one for whichJsonNode.isMissingNode()returnstrue) nor "null node" (one for whichJsonNode.isNull()returnstrue). If non-null non-missing node,thisis returned to allow chaining; otherwiseIllegalArgumentExceptionis thrown.- Overrides:
requireNonNullin classJsonNode- Returns:
thisnode to allow chaining
-
hashCode
public int hashCode()
- Specified by:
hashCodein classBaseJsonNode
-
toString
public String toString()
Description copied from class:JsonNodeMethod that will produce (as of Jackson 2.10) valid JSON using default settings of databind, as String. If you want other kinds of JSON output (or output formatted using one of other Jackson-supported data formats) make sure to useObjectMapperorObjectWriterto 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:
toStringin classBaseJsonNode
-
toPrettyString
public String toPrettyString()
Description copied from class:JsonNodeAlternative toJsonNode.toString()that will serialize this node using Jackson default pretty-printer.- Overrides:
toPrettyStringin classBaseJsonNode
-
equals
public boolean equals(Object o)
Description copied from class:JsonNodeEquality 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.
-
-