Class BaseJsonNode
- All Implemented Interfaces:
TreeNode
,JsonSerializable
,Serializable
,Iterable<JsonNode>
- Direct Known Subclasses:
ContainerNode
,ValueNode
JsonNode
implementations.
The main addition here is that we declare that sub-classes must
implement JsonSerializable
.
This simplifies object mapping aspects a bit, as no external serializers are needed.
Since 2.10, all implements have been Serializable
.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializable
JsonSerializable.Base
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract JsonToken
asToken()
Method that can be used for efficient type detection when using stream abstraction for traversing nodes.final JsonNode
Method similar toJsonNode.findValue(java.lang.String)
, but that will return a "missing node" instead of null if no field is found.abstract int
hashCode()
Returns code that identifies type of underlying numeric value, if (and only if) node is a number node.required
(int index) Method is functionally equivalent topath(index).required()
and can be used to check that this node is anArrayNode
(that is, represents JSON Array value) and has value for specifiedindex
(but note that value may be explicit JSON null value).Method is functionally equivalent topath(fieldName).required()
and can be used to check that this node is anObjectNode
(that is, represents JSON Object value) and has value for specified property with keyfieldName
(but note that value may be explicit JSON null value).abstract void
serialize
(JsonGenerator jgen, SerializerProvider provider) Method called to serialize node instances using given generator.abstract void
serializeWithType
(JsonGenerator jgen, SerializerProvider provider, TypeSerializer typeSer) Type information is needed, even if JsonNode instances are "plain" JSON, since they may be mixed with other types.Alternative toJsonNode.toString()
that will serialize this node using Jackson default pretty-printer.toString()
Method that will produce (as of Jackson 2.10) valid JSON using default settings of databind, as String.traverse()
Method for constructing aJsonParser
instance for iterating over contents of the tree that this node is root of.traverse
(ObjectCodec codec) Same asTreeNode.traverse()
, but additionally passesObjectCodec
to use ifJsonParser.readValueAs(Class)
is used (otherwise caller must callJsonParser.setCodec(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.ObjectCodec)
on response explicitly).Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonNode
_at, _reportRequiredViolation, _this, asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, asText, asText, at, at, bigIntegerValue, binaryValue, booleanValue, canConvertToExactIntegral, canConvertToInt, canConvertToLong, decimalValue, deepCopy, doubleValue, elements, equals, equals, fieldNames, fields, findParent, findParents, findParents, findValue, findValues, findValues, findValuesAsText, findValuesAsText, floatValue, get, get, getNodeType, has, has, hasNonNull, hasNonNull, intValue, isArray, isBigDecimal, isBigInteger, isBinary, isBoolean, isContainerNode, isDouble, isEmpty, isFloat, isFloatingPointNumber, isInt, isIntegralNumber, isLong, isMissingNode, isNull, isNumber, isObject, isPojo, isShort, isTextual, isValueNode, iterator, longValue, numberValue, path, path, require, requiredAt, requiredAt, requireNonNull, shortValue, size, textValue, with, withArray
Methods inherited from class edu.internet2.middleware.grouperClientExt.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
-
Constructor Details
-
BaseJsonNode
protected BaseJsonNode()
-
-
Method Details
-
findPath
Description copied from class:JsonNode
Method similar toJsonNode.findValue(java.lang.String)
, but that will return a "missing node" instead of null if no field is found. Missing node is a specific kind of node for whichJsonNode.isMissingNode()
returns true; and all value access methods return empty or missing value. -
hashCode
public abstract int hashCode() -
required
Description copied from class:JsonNode
Method is functionally equivalent topath(fieldName).required()
and can be used to check that this node is anObjectNode
(that is, represents JSON Object value) and has value for specified property with keyfieldName
(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; otherwiseIllegalArgumentException
is thrown. -
required
Description copied from class:JsonNode
Method is functionally equivalent topath(index).required()
and can be used to check that this node is anArrayNode
(that is, represents JSON Array value) and has value for specifiedindex
(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; otherwiseIllegalArgumentException
is thrown. -
traverse
Description copied from interface:TreeNode
Method for constructing aJsonParser
instance for iterating over contents of the tree that this node is root of. Functionally equivalent to first serializing tree usingObjectCodec
and then re-parsing but more efficient.NOTE: constructed parser instance will NOT initially point to a token, so before passing it to deserializers, it is typically necessary to advance it to the first available token by calling
JsonParser.nextToken()
.Also note that calling this method will NOT pass
ObjectCodec
reference, so data-binding callback methods likeJsonParser.readValueAs(Class)
will not work with callingJsonParser.setCodec(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.ObjectCodec)
). It is often better to callTreeNode.traverse(ObjectCodec)
to pass the codec explicitly.- Specified by:
traverse
in interfaceTreeNode
- Returns:
JsonParser
that will stream over contents of this node
-
traverse
Description copied from interface:TreeNode
Same asTreeNode.traverse()
, but additionally passesObjectCodec
to use ifJsonParser.readValueAs(Class)
is used (otherwise caller must callJsonParser.setCodec(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.ObjectCodec)
on response explicitly).NOTE: constructed parser instance will NOT initially point to a token, so before passing it to deserializers, it is typically necessary to advance it to the first available token by calling
JsonParser.nextToken()
.- Specified by:
traverse
in interfaceTreeNode
- Parameters:
codec
-ObjectCodec
to associate with parser constructed- Returns:
JsonParser
that will stream over contents of this node
-
asToken
Method that can be used for efficient type detection when using stream abstraction for traversing nodes. Will return the firstJsonToken
that equivalent stream event would produce (for most nodes there is just one token but for structured/container types multiple) -
numberType
Returns code that identifies type of underlying numeric value, if (and only if) node is a number node.- Specified by:
numberType
in interfaceTreeNode
- Returns:
- Type of number contained, if any; or null if node does not contain numeric value.
-
serialize
Method called to serialize node instances using given generator.- Specified by:
serialize
in interfaceJsonSerializable
- Throws:
IOException
-
serializeWithType
public abstract void serializeWithType(JsonGenerator jgen, SerializerProvider provider, TypeSerializer typeSer) throws IOException Type information is needed, even if JsonNode instances are "plain" JSON, since they may be mixed with other types.- Specified by:
serializeWithType
in interfaceJsonSerializable
- Throws:
IOException
-
toString
Description copied from class:JsonNode
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 useObjectMapper
orObjectWriter
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. -
toPrettyString
Description copied from class:JsonNode
Alternative toJsonNode.toString()
that will serialize this node using Jackson default pretty-printer.- Overrides:
toPrettyString
in classJsonNode
-