Module tools.jackson.core
Package tools.jackson.core
package tools.jackson.core
Main public API classes of the core streaming JSON
processor: most importantly
JsonFactory
used for constructing
JSON parser (JsonParser)
and generator
(JsonGenerator)
instances.
Public API of the higher-level mapping interfaces ("Mapping API") is found from the "jackson-databind" bundle, except for following base interfaces that are defined here:
TreeNodeis included within Streaming API to support integration of the Tree Model (which is based onJsonNode) with the basic parsers and generators (iff using mapping-supporting factory: which is part of Mapping API, not core)ObjectReadContextis included so that reference to the object capable of deserializing Objects from token streams (usually,tools.jackson.databind.ObjectMapper) can be exposed, without adding direct dependency to implementation.ObjectWriteContextis included so that reference to the object capable of serializing Objects from token streams (usually,tools.jackson.databind.ObjectMapper) can be exposed, without adding direct dependency to implementation.
-
ClassDescriptionClass used to define specific details of which variant of Base64 encoding/decoding is to be used.Defines how the Base64Variant deals with Padding while readingContainer for commonly used Base64 variants:
Base64Variants.MIMEBase64Variants.MIME_NO_LINEFEEDSBase64Variants.PEMBase64Variants.MODIFIED_FOR_URLSee entries for full description of differences.Container for configuration values used when handling errorneous token inputs.Marker interface that is to be implemented by data format - specific features.Simple tag interface used to mark schema objects that are used by someJsonParserandJsonGeneratorimplementations to further specify structure of expected format.Base class for all Jackson-produced checked exceptions.Simple bean class used to contain references.Enumeration that defines legal encodings that can be used for JSON content, based on list of allowed encodings from JSON specification.Base class that defines public API for writing JSON content.Base class that defines public API for reading JSON content.Enumeration of possible "native" (optimal) types that can be used for numbers.Enumeration of possible physical Floating-Point types that underlying format uses.Implementation of JSON Pointer specification.Enumeration for basic token types used for returning results of parsing JSON content.Interface defined to contain ids accessible withJsonToken.id().Defines API for accessing configuration and state exposed by higher level databind functionality during read (token stream to Object deserialization) process.Default no-op implementation.Defines API for accessing configuration and state exposed by higher level databind functionality during write (Object to token stream serialization) process.Default no-op implementation.Interface for objects that implement pretty printer functionality, such as indentation.Interface that defines how Jackson package can interact with efficient pre-serialized or lazily-serialized and reused String representations.Set of on/off capabilities that aJsonParserfor given format (or in case of buffering, original format) has.The constraints to use for streaming reads: used to guard against malicious input by preventing processing of "too big" input constructs (values, structures).Token reader (parser) features not-specific to any particular format backend.Set of on/off capabilities that aJsonGeneratorfor given format (or in case of buffering, original format) has.The constraints to use for streaming writes: used to guard against problematic output by preventing processing of "too big" output constructs (values, structures).Token writer (generator) features not-specific to any particular format backend.Shared base class for streaming processing contexts used during reading and writing of token streams using Streaming API.The main factory class of Jackson streaming package, used to configure and construct token reader (aka parser,JsonParser) and token writer (aka generator,JsonGenerator) instances.Enumeration that defines all on/off features that can only be changed forTokenStreamFactory.Object that encapsulates Location information used for reporting parsing (or potentially generation) errors, as well as current location within input streams.Interface that defines objects that can read and writeTreeNodeinstances using Streaming API.Marker interface used to denote JSON Tree nodes, as far as the core package knows them (which is very little): mostly needed to allowObjectReadContextandObjectWriteContextto have some level of interoperability.Since factory instances are immutable, a Builder class is needed for creating configurations for differently configured factory instances.Object that encapsulates versioning information of a component.Interface that those Jackson components that are explicitly versioned will implement.