public abstract Class BaseJsonNode

Redeclares com.fasterxml.jackson.core.TreeNode.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

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

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

Method similar to findValue, but that will return a "missing node" instead of null if no field is found. Missing node is a specific kind of node for which isMissingNode returns true; and all value access methods return empty or missing value.

Parameters

fieldName:String

Name of field to look for

Returns:JsonNode

Value of first matching node found; or if not found, a "missing node" (non-null instance that has no value)

Annotations

@Override

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

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.

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

Overrides com.fasterxml.jackson.databind.JsonNode.required.

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

Method is functionally equivalent to path(fieldName).required() and can be used to check that this node is an ObjectNode (that is, represents JSON Object value) and has value for specified property with key fieldName (but note that value may be explicit JSON null value). If this node is Object Node and has value for specified property, matching value is returned; otherwise IllegalArgumentException is thrown.

Parameters

fieldName:String

Name of property to access

Returns:JsonNode

Value of the specified property of this Object node

Annotations

@Override

Overrides com.fasterxml.jackson.databind.JsonNode.required.

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

Method is functionally equivalent to path(index).required() and can be used to check that this node is an ArrayNode (that is, represents JSON Array value) and has value for specified index (but note that value may be explicit JSON null value). If this node is Array Node and has value for specified index, value at index is returned; otherwise IllegalArgumentException is thrown.

Parameters

index:int

Index of the value of this Array node to access

Returns:JsonNode

Value at specified index of this Array node

Annotations

@Override

Redeclares com.fasterxml.jackson.databind.JsonSerializable.serialize.

Method called to serialize node instances using given generator.

Annotations

@Override

Redeclares com.fasterxml.jackson.databind.JsonSerializable.serializeWithType.

Type information is needed, even if JsonNode instances are "plain" JSON, since they may be mixed with other types.

Annotations

@Override

Overrides com.fasterxml.jackson.databind.JsonNode.toPrettyString.

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

Alternative to toString that will serialize this node using Jackson default pretty-printer.

Annotations

@Override

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

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

Method 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 use ObjectMapper or ObjectWriter to serialize an instance, for example:

   String json = objectMapper.writeValueAsString(rootNode);

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override

Implements com.fasterxml.jackson.core.TreeNode.traverse.

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

Method for constructing a JsonParser instance for iterating over contents of the tree that this node is root of. Functionally equivalent to first serializing tree using ObjectCodec and then re-parsing but more efficient.

Also note that calling this method will NOT pass ObjectCodec reference, so data-binding callback methods like JsonParser#readValueAs(Class) will not work with calling JsonParser#setCodec). It is often better to call traverse(ObjectCodec) to pass the codec explicitly.

Returns:JsonParser

JsonParser that will stream over contents of this node

Annotations

@Override

Implements com.fasterxml.jackson.core.TreeNode.traverse.

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

Same as traverse(), but additionally passes com.fasterxml.jackson.core.ObjectCodec to use if JsonParser#readValueAs(Class) is used (otherwise caller must call JsonParser#setCodec on response explicitly).

Parameters

codec:ObjectCodec

ObjectCodec to associate with parser constructed

Returns:JsonParser

JsonParser that will stream over contents of this node

Annotations

@Override

Overrides com.fasterxml.jackson.databind.JsonNode.withArray.

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

Method that can be called on Object or Array nodes, to access a Array-valued node pointed to by given JsonPointer, if such a node exists: or if not, an attempt is made to create one and return it. For example, on document

  { "a" : {
       "b" : [ 1, 2 ]
    }
  }

  [ 1, 2 ]

In cases where path leads to "missing" nodes, a path is created. So, for example, on above document, and JsonPointer of /a/x an empty ArrayNode would be returned and the document would look like:

  { "a" : {
       "b" : [ 1, 2 ],
       "x" : [ ]
    }
  }

  { "a" : {
       "b" : [ [ ], 2 ],
       "x" : [ ]
    }
  }

Parameters

ptr:JsonPointer

Pointer that indicates path to use for ArrayNode value to return (potentially creating it as necessary)

overwriteMode:JsonNode.OverwriteMode

Defines which node types may be converted in case of incompatible JsonPointer expression: if conversion not allowed, an exception is thrown.

preferIndex:boolean

When creating a path (for empty or replacement), and path contains segment that may be an array index (simple integer number like 3), whether to construct an ArrayNode (true) or ObjectNode (false). In latter case matching property with quoted number (like "3") is used within Object.

Returns:ArrayNode

ArrayNode found or created

Annotations

@Override

Overrides com.fasterxml.jackson.databind.JsonNode.withObject.

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

Method that can be called on Object or Array nodes, to access a Object-valued node pointed to by given JsonPointer, if such a node exists: or if not, an attempt is made to create one and return it. For example, on document

  { "a" : {
       "b" : {
          "c" : 13
       }
    }
  }

  { "c" : 13 }

In cases where path leads to "missing" nodes, a path is created. So, for example, on above document, and JsonPointer of /a/x an empty ObjectNode would be returned and the document would look like:

  { "a" : {
       "b" : {
          "c" : 13
       },
       "x" : { }
    }
  }

  { "a" : {
       "b" : {
          "c" : { }
       },
       "x" : { }
    }
  }

Parameters

ptr:JsonPointer

Pointer that indicates path to use for ObjectNode value to return (potentially creating one as necessary)

overwriteMode:JsonNode.OverwriteMode

Defines which node types may be converted in case of incompatible JsonPointer expression: if conversion not allowed, UnsupportedOperationException is thrown.

preferIndex:boolean

When creating a path (for empty or replacement), and path contains segment that may be an array index (simple integer number like 3), whether to construct an ArrayNode (true) or ObjectNode (false). In latter case matching property with quoted number (like "3") is used within Object.

Returns:ObjectNode

ObjectNode found or created

Annotations

@Override