| Package | Description |
|---|---|
| com.fasterxml.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. |
| com.fasterxml.jackson.core.base |
Base classes used by concrete Parser and Generator implementations;
contain functionality that is not specific to JSON or input
abstraction (byte vs char).
|
| com.fasterxml.jackson.core.exc |
Package for some of
JsonProcessingException
subtypes contained by streaming API. |
| com.fasterxml.jackson.core.filter | |
| com.fasterxml.jackson.core.json |
JSON-specific parser and generator implementation classes that
Jackson defines and uses.
|
| com.fasterxml.jackson.core.util |
Utility classes used by Jackson Core functionality.
|
| Modifier and Type | Method and Description |
|---|---|
protected JsonGenerator |
JsonFactory._createGenerator(Writer out,
IOContext ctxt)
Overridable factory method that actually instantiates generator for
given
Writer and context object. |
protected JsonGenerator |
JsonFactory._createUTF8Generator(OutputStream out,
IOContext ctxt)
Overridable factory method that actually instantiates generator for
given
OutputStream and context object, using UTF-8 encoding. |
protected JsonGenerator |
JsonFactory._decorate(JsonGenerator g)
Helper method for applying all registered
JsonGeneratorDecorators
on freshly constructed JsonGenerator. |
JsonGenerator |
JsonGenerator.configure(JsonGenerator.Feature f,
boolean state)
Method for enabling or disabling specified feature:
check
JsonGenerator.Feature for list of available features. |
abstract JsonGenerator |
TokenStreamFactory.createGenerator(DataOutput out) |
JsonGenerator |
JsonFactory.createGenerator(DataOutput out)
Convenience method for constructing generator that uses default
encoding of the format (UTF-8 for JSON and most other data formats).
|
abstract JsonGenerator |
TokenStreamFactory.createGenerator(DataOutput out,
JsonEncoding enc) |
JsonGenerator |
JsonFactory.createGenerator(DataOutput out,
JsonEncoding enc)
Method for constructing generator for writing content using specified
DataOutput instance. |
abstract JsonGenerator |
TokenStreamFactory.createGenerator(File f,
JsonEncoding enc) |
JsonGenerator |
JsonFactory.createGenerator(File f,
JsonEncoding enc)
Method for constructing JSON generator for writing JSON content
to specified file, overwriting contents it might have (or creating
it if such file does not yet exist).
|
abstract JsonGenerator |
TokenStreamFactory.createGenerator(OutputStream out) |
JsonGenerator |
JsonFactory.createGenerator(OutputStream out)
Convenience method for constructing generator that uses default
encoding of the format (UTF-8 for JSON and most other data formats).
|
abstract JsonGenerator |
TokenStreamFactory.createGenerator(OutputStream out,
JsonEncoding enc) |
JsonGenerator |
JsonFactory.createGenerator(OutputStream out,
JsonEncoding enc)
Method for constructing JSON generator for writing JSON content
using specified output stream.
|
abstract JsonGenerator |
TokenStreamFactory.createGenerator(Writer w) |
JsonGenerator |
JsonFactory.createGenerator(Writer w)
Method for constructing JSON generator for writing JSON content
using specified Writer.
|
JsonGenerator |
JsonFactory.createJsonGenerator(OutputStream out)
Deprecated.
Since 2.2, use
JsonFactory.createGenerator(OutputStream) instead. |
JsonGenerator |
JsonFactory.createJsonGenerator(OutputStream out,
JsonEncoding enc)
Deprecated.
Since 2.2, use
JsonFactory.createGenerator(OutputStream, JsonEncoding) instead. |
JsonGenerator |
JsonFactory.createJsonGenerator(Writer out)
Deprecated.
Since 2.2, use
JsonFactory.createGenerator(Writer) instead. |
abstract JsonGenerator |
JsonGenerator.disable(JsonGenerator.Feature f)
Method for disabling specified feature
(check
JsonGenerator.Feature for list of features) |
abstract JsonGenerator |
JsonGenerator.enable(JsonGenerator.Feature f)
Method for enabling specified generator feature:
check
JsonGenerator.Feature for list of available features. |
JsonGenerator |
JsonGenerationException.getProcessor() |
JsonGenerator |
JsonGenerator.overrideFormatFeatures(int values,
int mask)
Bulk set method for (re)setting states of
FormatFeatures,
by specifying values (set / clear) along with a mask, to determine
which features to change, if any. |
JsonGenerator |
JsonGenerator.overrideStdFeatures(int values,
int mask)
Bulk set method for (re)setting states of features specified by
mask. |
JsonGenerator |
JsonGenerator.setCharacterEscapes(CharacterEscapes esc)
Method for defining custom escapes factory uses for
JsonGenerators
it creates. |
abstract JsonGenerator |
JsonGenerator.setCodec(ObjectCodec oc)
Method that can be called to set or reset the object to
use for writing Java objects as JsonContent
(using method
writeObject(java.lang.Object)). |
abstract JsonGenerator |
JsonGenerator.setFeatureMask(int values)
Deprecated.
Since 2.7, use
overrideStdFeatures(int, int) instead -- remove from 2.9 |
JsonGenerator |
JsonGenerator.setHighestNonEscapedChar(int charCode)
Method that can be called to request that generator escapes
all character codes above specified code point (if positive value);
or, to not escape any characters except for ones that must be
escaped for the data format (if -1).
|
JsonGenerator |
JsonGenerator.setPrettyPrinter(PrettyPrinter pp)
Method for setting a custom pretty printer, which is usually
used to add indentation for improved human readability.
|
JsonGenerator |
JsonGenerator.setRootValueSeparator(SerializableString sep)
Method that allows overriding String used for separating root-level
JSON values (default is single space character)
Default implementation throws
UnsupportedOperationException. |
abstract JsonGenerator |
JsonGenerator.useDefaultPrettyPrinter()
Convenience method for enabling pretty-printing using
the default pretty printer
(
DefaultPrettyPrinter). |
| Modifier and Type | Method and Description |
|---|---|
protected JsonGenerator |
JsonFactory._decorate(JsonGenerator g)
Helper method for applying all registered
JsonGeneratorDecorators
on freshly constructed JsonGenerator. |
void |
PrettyPrinter.beforeArrayValues(JsonGenerator gen)
Method called after array start marker has been output,
and right before the first value is to be output.
|
void |
PrettyPrinter.beforeObjectEntries(JsonGenerator gen)
Method called after object start marker has been output,
and right before the field name of the first entry is
to be output.
|
JsonGenerationException |
JsonGenerationException.withGenerator(JsonGenerator g)
Fluent method that may be used to assign originating
JsonGenerator,
to be accessed using JsonGenerationException.getProcessor(). |
void |
PrettyPrinter.writeArrayValueSeparator(JsonGenerator gen)
Method called after an array value has been completely
output, and before another value is to be output.
|
void |
PrettyPrinter.writeEndArray(JsonGenerator gen,
int nrOfValues)
Method called after an Array value has been completely output
(minus closing bracket).
|
void |
PrettyPrinter.writeEndObject(JsonGenerator gen,
int nrOfEntries)
Method called after an Object value has been completely output
(minus closing curly bracket).
|
void |
PrettyPrinter.writeObjectEntrySeparator(JsonGenerator gen)
Method called after an Object entry (field:value) has been completely
output, and before another value is to be output.
|
void |
PrettyPrinter.writeObjectFieldValueSeparator(JsonGenerator gen)
Method called after an object field has been output, but
before the value is output.
|
void |
PrettyPrinter.writeRootValueSeparator(JsonGenerator gen)
Method called after a root-level value has been completely
output, and before another value is to be output.
|
void |
PrettyPrinter.writeStartArray(JsonGenerator gen)
Method called when an Array value is to be output, before
any member/child values are output.
|
void |
PrettyPrinter.writeStartObject(JsonGenerator gen)
Method called when an Object value is to be output, before
any fields are output.
|
abstract void |
TreeCodec.writeTree(JsonGenerator g,
TreeNode tree) |
abstract void |
ObjectCodec.writeTree(JsonGenerator gen,
TreeNode tree)
Method for serializing JSON content from given Tree instance, using
specified generator.
|
abstract void |
ObjectCodec.writeValue(JsonGenerator gen,
Object value)
Method to serialize given Java Object, using generator
provided.
|
| Constructor and Description |
|---|
JsonGenerationException(String msg,
JsonGenerator g) |
JsonGenerationException(String msg,
Throwable rootCause,
JsonGenerator g) |
JsonGenerationException(Throwable rootCause,
JsonGenerator g) |
| Modifier and Type | Class and Description |
|---|---|
class |
GeneratorBase
This base class implements part of API that a JSON generator exposes
to applications, adds shared internal methods that sub-classes
can use and adds some abstract methods sub-classes must implement.
|
| Modifier and Type | Method and Description |
|---|---|
JsonGenerator |
GeneratorBase.disable(JsonGenerator.Feature f) |
JsonGenerator |
GeneratorBase.enable(JsonGenerator.Feature f) |
JsonGenerator |
GeneratorBase.overrideStdFeatures(int values,
int mask) |
JsonGenerator |
GeneratorBase.setCodec(ObjectCodec oc) |
JsonGenerator |
GeneratorBase.setFeatureMask(int newMask)
Deprecated.
|
JsonGenerator |
GeneratorBase.useDefaultPrettyPrinter() |
| Modifier and Type | Field and Description |
|---|---|
protected JsonGenerator |
StreamWriteException._processor |
| Modifier and Type | Method and Description |
|---|---|
JsonGenerator |
StreamWriteException.getProcessor() |
| Modifier and Type | Method and Description |
|---|---|
abstract StreamWriteException |
StreamWriteException.withGenerator(JsonGenerator g)
Fluent method that may be used to assign originating
JsonGenerator,
to be accessed using StreamWriteException.getProcessor(). |
| Constructor and Description |
|---|
StreamWriteException(String msg,
JsonGenerator g) |
StreamWriteException(String msg,
Throwable rootCause,
JsonGenerator g) |
StreamWriteException(Throwable rootCause,
JsonGenerator g) |
| Modifier and Type | Class and Description |
|---|---|
class |
FilteringGeneratorDelegate
Specialized
JsonGeneratorDelegate that allows use of
TokenFilter for outputting a subset of content that
caller tries to generate. |
| Modifier and Type | Method and Description |
|---|---|
TokenFilterContext |
TokenFilterContext.closeArray(JsonGenerator gen) |
TokenFilterContext |
TokenFilterContext.closeObject(JsonGenerator gen) |
void |
TokenFilterContext.ensureFieldNameWritten(JsonGenerator gen)
Method called to ensure that field name, if present, has been written;
may result (but does not always) in a call using given generator
|
void |
TokenFilterContext.writePath(JsonGenerator gen)
Method called to ensure that parent path from root is written up to
and including this node.
|
| Constructor and Description |
|---|
FilteringGeneratorDelegate(JsonGenerator d,
TokenFilter f,
boolean includePath,
boolean allowMultipleMatches)
Deprecated.
since 2.12 Use the constructor that takes
TokenFilter.Inclusion
argument instead. |
FilteringGeneratorDelegate(JsonGenerator d,
TokenFilter f,
TokenFilter.Inclusion inclusion,
boolean allowMultipleMatches) |
| Modifier and Type | Class and Description |
|---|---|
class |
JsonGeneratorImpl
Intermediate base class shared by JSON-backed generators
like
UTF8JsonGenerator and WriterBasedJsonGenerator. |
class |
UTF8JsonGenerator |
class |
WriterBasedJsonGenerator
JsonGenerator that outputs JSON content using a Writer
which handles character encoding. |
| Modifier and Type | Method and Description |
|---|---|
JsonGenerator |
JsonGeneratorImpl.disable(JsonGenerator.Feature f) |
JsonGenerator |
JsonGeneratorImpl.enable(JsonGenerator.Feature f) |
JsonGenerator |
JsonGeneratorImpl.setCharacterEscapes(CharacterEscapes esc) |
JsonGenerator |
JsonGeneratorImpl.setHighestNonEscapedChar(int charCode) |
JsonGenerator |
JsonGeneratorImpl.setRootValueSeparator(SerializableString sep) |
| Modifier and Type | Method and Description |
|---|---|
static DupDetector |
DupDetector.rootDetector(JsonGenerator g) |
| Modifier and Type | Class and Description |
|---|---|
class |
JsonGeneratorDelegate |
| Modifier and Type | Field and Description |
|---|---|
protected JsonGenerator |
JsonGeneratorDelegate.delegate
Delegate object that method calls are delegated to.
|
| Modifier and Type | Method and Description |
|---|---|
JsonGenerator |
JsonGeneratorDecorator.decorate(JsonFactory factory,
JsonGenerator generator)
Allow to decorate
JsonGenerator instances returned by JsonFactory. |
JsonGenerator |
JsonGeneratorDelegate.delegate() |
JsonGenerator |
JsonGeneratorDelegate.disable(JsonGenerator.Feature f) |
JsonGenerator |
JsonGeneratorDelegate.enable(JsonGenerator.Feature f) |
JsonGenerator |
JsonGeneratorDelegate.getDelegate()
Deprecated.
|
JsonGenerator |
JsonGeneratorDelegate.overrideFormatFeatures(int values,
int mask) |
JsonGenerator |
JsonGeneratorDelegate.overrideStdFeatures(int values,
int mask) |
JsonGenerator |
JsonGeneratorDelegate.setCharacterEscapes(CharacterEscapes esc) |
JsonGenerator |
JsonGeneratorDelegate.setCodec(ObjectCodec oc) |
JsonGenerator |
JsonGeneratorDelegate.setFeatureMask(int mask)
Deprecated.
|
JsonGenerator |
JsonGeneratorDelegate.setHighestNonEscapedChar(int charCode) |
JsonGenerator |
JsonGeneratorDelegate.setPrettyPrinter(PrettyPrinter pp) |
JsonGenerator |
JsonGeneratorDelegate.setRootValueSeparator(SerializableString sep) |
JsonGenerator |
JsonGeneratorDelegate.useDefaultPrettyPrinter() |
| Modifier and Type | Method and Description |
|---|---|
void |
MinimalPrettyPrinter.beforeArrayValues(JsonGenerator g) |
void |
DefaultPrettyPrinter.beforeArrayValues(JsonGenerator g) |
void |
MinimalPrettyPrinter.beforeObjectEntries(JsonGenerator g) |
void |
DefaultPrettyPrinter.beforeObjectEntries(JsonGenerator g) |
JsonGenerator |
JsonGeneratorDecorator.decorate(JsonFactory factory,
JsonGenerator generator)
Allow to decorate
JsonGenerator instances returned by JsonFactory. |
void |
MinimalPrettyPrinter.writeArrayValueSeparator(JsonGenerator g)
Method called after an array value has been completely
output, and before another value is to be output.
|
void |
DefaultPrettyPrinter.writeArrayValueSeparator(JsonGenerator g)
Method called after an array value has been completely
output, and before another value is to be output.
|
void |
MinimalPrettyPrinter.writeEndArray(JsonGenerator g,
int nrOfValues) |
void |
DefaultPrettyPrinter.writeEndArray(JsonGenerator g,
int nrOfValues) |
void |
MinimalPrettyPrinter.writeEndObject(JsonGenerator g,
int nrOfEntries) |
void |
DefaultPrettyPrinter.writeEndObject(JsonGenerator g,
int nrOfEntries) |
void |
DefaultPrettyPrinter.Indenter.writeIndentation(JsonGenerator g,
int level) |
void |
DefaultPrettyPrinter.NopIndenter.writeIndentation(JsonGenerator g,
int level) |
void |
DefaultPrettyPrinter.FixedSpaceIndenter.writeIndentation(JsonGenerator g,
int level) |
void |
DefaultIndenter.writeIndentation(JsonGenerator jg,
int level) |
void |
MinimalPrettyPrinter.writeObjectEntrySeparator(JsonGenerator g)
Method called after an object entry (field:value) has been completely
output, and before another value is to be output.
|
void |
DefaultPrettyPrinter.writeObjectEntrySeparator(JsonGenerator g)
Method called after an object entry (field:value) has been completely
output, and before another value is to be output.
|
void |
MinimalPrettyPrinter.writeObjectFieldValueSeparator(JsonGenerator g)
Method called after an object field has been output, but
before the value is output.
|
void |
DefaultPrettyPrinter.writeObjectFieldValueSeparator(JsonGenerator g)
Method called after an object field has been output, but
before the value is output.
|
void |
MinimalPrettyPrinter.writeRootValueSeparator(JsonGenerator g) |
void |
DefaultPrettyPrinter.writeRootValueSeparator(JsonGenerator g) |
void |
MinimalPrettyPrinter.writeStartArray(JsonGenerator g) |
void |
DefaultPrettyPrinter.writeStartArray(JsonGenerator g) |
void |
MinimalPrettyPrinter.writeStartObject(JsonGenerator g) |
void |
DefaultPrettyPrinter.writeStartObject(JsonGenerator g) |
| Constructor and Description |
|---|
JsonGeneratorDelegate(JsonGenerator d) |
JsonGeneratorDelegate(JsonGenerator d,
boolean delegateCopyMethods) |
Copyright © 2008–2025 FasterXML. All rights reserved.