Jackson 3.0.1 · tools.jackson.core · APIdia, the JavaDoc alternative

Main public API classes of the core streaming JSON processor: most importantly tools.jackson.core.json.JsonFactory used for constructing JSON parser (tools.jackson.core.JsonParser) and generator (tools.jackson.core.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:

tools.jackson.core.TreeNode is included within Streaming API to support integration of the Tree Model (which is based on JsonNode) with the basic parsers and generators (iff using mapping-supporting factory: which is part of Mapping API, not core)
tools.jackson.core.ObjectReadContext is 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.
tools.jackson.core.ObjectWriteContext is 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.

Interface Summary

Modifier and Type	Interface and Description
public interface	FormatFeature Marker interface that is to be implemented by data format - specific features.
public interface	FormatSchema Simple tag interface used to mark schema objects that are used by some `JsonParser` and `JsonGenerator` implementations to further specify structure of expected format.
public interface	JsonTokenId Interface defined to contain ids accessible with `JsonToken#id()`.
public interface	ObjectReadContext Defines API for accessing configuration and state exposed by higher level databind functionality during read (token stream to Object deserialization) process.
public interface	ObjectWriteContext Defines API for accessing configuration and state exposed by higher level databind functionality during write (Object to token stream serialization) process.
public interface	PrettyPrinter Interface for objects that implement pretty printer functionality, such as indentation.
public interface	SerializableString Interface that defines how Jackson package can interact with efficient pre-serialized or lazily-serialized and reused String representations.
public interface	TreeCodec Interface that defines objects that can read and write `TreeNode` instances using Streaming API.
public interface	TreeNode Marker interface used to denote JSON Tree nodes, as far as the core package knows them (which is very little): mostly needed to allow `ObjectReadContext` and `ObjectWriteContext` to have some level of interoperability.
public interface	Versioned Interface that those Jackson components that are explicitly versioned will implement.

Class Summary

Modifier and Type	Class and Description
public class	Base64Variant Class used to define specific details of which variant of Base64 encoding/decoding is to be used.
public class	Base64Variants Container for commonly used Base64 variants: `MIME` `MIME_NO_LINEFEEDS` `PEM` `MODIFIED_FOR_URL`
public class	ErrorReportConfiguration Container for configuration values used when handling errorneous token inputs.
public class	JacksonException Base class for all Jackson-produced checked exceptions.
public abstract class	JsonGenerator Base class that defines public API for writing JSON content.
public abstract class	JsonParser Base class that defines public API for reading JSON content.
public class	JsonPointer Implementation of JSON Pointer specification.
public class	StreamReadConstraints The constraints to use for streaming reads: used to guard against malicious input by preventing processing of "too big" input constructs (values, structures).
public class	StreamWriteConstraints The constraints to use for streaming writes: used to guard against problematic output by preventing processing of "too big" output constructs (values, structures).
public abstract class	TokenStreamContext Shared base class for streaming processing contexts used during reading and writing of token streams using Streaming API.
public abstract class	TokenStreamFactory 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.
public class	TokenStreamLocation Object that encapsulates Location information used for reporting parsing (or potentially generation) errors, as well as current location within input streams.
public abstract class	TSFBuilder<F extends TokenStreamFactory, B extends TSFBuilder<F, B>> Since factory instances are immutable, a Builder class is needed for creating configurations for differently configured factory instances.
public class	Version Object that encapsulates versioning information of a component.

Enum Summary

Modifier and Type	Enum and Description
public enum	JsonEncoding Enumeration that defines legal encodings that can be used for JSON content, based on list of allowed encodings from JSON specification.
public enum	JsonToken Enumeration for basic token types used for returning results of parsing JSON content.
public enum	StreamReadCapability Set of on/off capabilities that a `JsonParser` for given format (or in case of buffering, original format) has.
public enum	StreamReadFeature Token reader (parser) features not-specific to any particular format backend.
public enum	StreamWriteCapability Set of on/off capabilities that a `JsonGenerator` for given format (or in case of buffering, original format) has.
public enum	StreamWriteFeature Token writer (generator) features not-specific to any particular format backend.

Package tools.jackson.core

Interface Summary

Class Summary

Enum Summary