public abstract class GeneratorBase extends JsonGenerator
JsonGenerator.Feature
Modifier and Type | Field and Description |
---|---|
protected boolean |
_cfgNumbersAsStrings
Flag set to indicate that implicit conversion from number
to JSON String is needed (as per
JsonGenerator.Feature.WRITE_NUMBERS_AS_STRINGS ). |
protected boolean |
_closed
Flag that indicates whether generator is closed or not.
|
protected int |
_features
Bit flag composed of bits that indicate which
JsonGenerator.Feature s
are enabled. |
protected ObjectCodec |
_objectCodec |
protected JsonWriteContext |
_writeContext
Object that keeps track of the current contextual state
of the generator.
|
protected static int |
DERIVED_FEATURES_MASK
Set of feature masks related to features that need updates of other
local configuration or state.
|
static int |
SURR1_FIRST |
static int |
SURR1_LAST |
static int |
SURR2_FIRST |
static int |
SURR2_LAST |
protected String |
WRITE_BINARY |
protected String |
WRITE_BOOLEAN |
protected String |
WRITE_NULL |
protected String |
WRITE_NUMBER |
protected String |
WRITE_RAW |
protected String |
WRITE_STRING |
_cfgPrettyPrinter
Modifier | Constructor and Description |
---|---|
protected |
GeneratorBase(int features,
ObjectCodec codec) |
protected |
GeneratorBase(int features,
ObjectCodec codec,
JsonWriteContext ctxt) |
Modifier and Type | Method and Description |
---|---|
protected void |
_checkStdFeatureChanges(int newFeatureFlags,
int changedFeatures)
Helper method called to verify changes to standard features.
|
protected PrettyPrinter |
_constructDefaultPrettyPrinter()
Overridable factory method called to instantiate an appropriate
PrettyPrinter
for case of "just use the default one", when useDefaultPrettyPrinter() is called. |
protected int |
_decodeSurrogate(int surr1,
int surr2) |
protected abstract void |
_releaseBuffers()
Method called to release any buffers generator may be holding,
once generator is being closed.
|
protected abstract void |
_verifyValueWrite(String typeMsg)
Method called before trying to write a value (scalar or structured),
to verify that this is legal in current output state, as well as to
output separators if and as necessary.
|
void |
close()
Method called to close this generator, so that no more content
can be written.
|
JsonGenerator |
disable(JsonGenerator.Feature f)
Method for disabling specified features
(check
JsonGenerator.Feature for list of features) |
JsonGenerator |
enable(JsonGenerator.Feature f)
Method for enabling specified parser features:
check
JsonGenerator.Feature for list of available features. |
abstract void |
flush()
Method called to flush any buffered content to the underlying
target (output stream, writer), and to flush the target itself
as well.
|
ObjectCodec |
getCodec()
Method for accessing the object used for writing Java
object as JSON content
(using method
JsonGenerator.writeObject(java.lang.Object) ). |
Object |
getCurrentValue()
Helper method, usually equivalent to:
getOutputContext().getCurrentValue();
|
int |
getFeatureMask()
Bulk access method for getting state of all standard (non-dataformat-specific)
JsonGenerator.Feature s. |
JsonStreamContext |
getOutputContext()
Note: type was co-variant until Jackson 2.7; reverted back to
base type in 2.8 to allow for overriding by subtypes that use
custom context type.
|
boolean |
isClosed()
Method that can be called to determine whether this generator
is closed or not.
|
boolean |
isEnabled(JsonGenerator.Feature f)
Method for checking whether given feature is enabled.
|
JsonGenerator |
overrideStdFeatures(int values,
int mask)
Bulk set method for (re)setting states of features specified by
mask . |
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
JsonGenerator.writeObject(java.lang.Object) ). |
void |
setCurrentValue(Object v)
Helper method, usually equivalent to:
getOutputContext().setCurrentValue(v);
|
JsonGenerator |
setFeatureMask(int newMask)
Deprecated.
|
JsonGenerator |
useDefaultPrettyPrinter()
Convenience method for enabling pretty-printing using
the default pretty printer
(
DefaultPrettyPrinter ). |
Version |
version()
Implemented with standard version number detection algorithm, typically using
a simple generated class, with information extracted from Maven project file
during build.
|
int |
writeBinary(Base64Variant b64variant,
InputStream data,
int dataLength)
Method similar to
JsonGenerator.writeBinary(Base64Variant,byte[],int,int) ,
but where input is provided through a stream, allowing for incremental
writes without holding the whole input in memory. |
void |
writeFieldName(SerializableString name)
Method similar to
JsonGenerator.writeFieldName(String) , main difference
being that it may perform better as some of processing (such as
quoting of certain characters, or encoding into external encoding
if supported by generator) can be done just once and reused for
later calls. |
void |
writeObject(Object value)
Method for writing given Java object (POJO) as Json.
|
void |
writeRawValue(char[] text,
int offset,
int len) |
void |
writeRawValue(SerializableString text)
Method similar to
JsonGenerator.writeRawValue(String) , but potentially more
efficient as it may be able to use pre-encoded content (similar to
JsonGenerator.writeRaw(SerializableString) . |
void |
writeRawValue(String text)
Method that will force generator to copy
input text verbatim without any modifications, but assuming
it must constitute a single legal JSON value (number, string,
boolean, null, Array or List).
|
void |
writeRawValue(String text,
int offset,
int len) |
void |
writeStartObject(Object forValue)
Method for writing starting marker of a JSON Object value
(character '{'; plus possible white space decoration
if pretty-printing is enabled), to represent Java given
as the argument.
|
void |
writeString(SerializableString text)
Method similar to
JsonGenerator.writeString(String) , but that takes
SerializableString which can make this potentially
more efficient to call as generator may be able to reuse
quoted and/or encoded representation. |
void |
writeTree(TreeNode rootNode)
Method for writing given JSON tree (expressed as a tree
where given JsonNode is the root) using this generator.
|
_reportError, _reportUnsupportedOperation, _throwInternal, _verifyOffsets, _writeSimpleObject, canOmitFields, canUseSchema, canWriteBinaryNatively, canWriteFormattedNumbers, canWriteObjectId, canWriteTypeId, configure, copyCurrentEvent, copyCurrentStructure, getCharacterEscapes, getFormatFeatures, getHighestEscapedChar, getOutputBuffered, getOutputTarget, getPrettyPrinter, getSchema, overrideFormatFeatures, setCharacterEscapes, setHighestNonEscapedChar, setPrettyPrinter, setRootValueSeparator, setSchema, writeArray, writeArray, writeArray, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBoolean, writeBooleanField, writeEmbeddedObject, writeEndArray, writeEndObject, writeFieldId, writeFieldName, writeNull, writeNullField, writeNumber, writeNumber, writeNumber, writeNumber, writeNumber, writeNumber, writeNumber, writeNumber, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeObjectId, writeObjectRef, writeOmittedField, writeRaw, writeRaw, writeRaw, writeRaw, writeRaw, writeRawUTF8String, writeStartArray, writeStartArray, writeStartObject, writeString, writeString, writeStringField, writeTypeId, writeUTF8String
public static final int SURR1_FIRST
public static final int SURR1_LAST
public static final int SURR2_FIRST
public static final int SURR2_LAST
protected static final int DERIVED_FEATURES_MASK
protected final String WRITE_BINARY
protected final String WRITE_BOOLEAN
protected final String WRITE_NULL
protected final String WRITE_NUMBER
protected final String WRITE_RAW
protected final String WRITE_STRING
protected ObjectCodec _objectCodec
protected int _features
JsonGenerator.Feature
s
are enabled.protected boolean _cfgNumbersAsStrings
JsonGenerator.Feature.WRITE_NUMBERS_AS_STRINGS
).protected JsonWriteContext _writeContext
protected boolean _closed
close()
).protected GeneratorBase(int features, ObjectCodec codec)
protected GeneratorBase(int features, ObjectCodec codec, JsonWriteContext ctxt)
public Version version()
version
in interface Versioned
version
in class JsonGenerator
public Object getCurrentValue()
JsonGenerator
getOutputContext().getCurrentValue();
Note that "current value" is NOT populated (or used) by Streaming parser; it is only used by higher-level data-binding functionality. The reason it is included here is that it can be stored and accessed hierarchically, and gets passed through data-binding.
getCurrentValue
in class JsonGenerator
public void setCurrentValue(Object v)
JsonGenerator
getOutputContext().setCurrentValue(v);
setCurrentValue
in class JsonGenerator
public final boolean isEnabled(JsonGenerator.Feature f)
JsonGenerator
JsonGenerator.Feature
for list of available features.isEnabled
in class JsonGenerator
public int getFeatureMask()
JsonGenerator
JsonGenerator.Feature
s.getFeatureMask
in class JsonGenerator
JsonGenerator.Feature
s.public JsonGenerator enable(JsonGenerator.Feature f)
JsonGenerator
JsonGenerator.Feature
for list of available features.enable
in class JsonGenerator
public JsonGenerator disable(JsonGenerator.Feature f)
JsonGenerator
JsonGenerator.Feature
for list of features)disable
in class JsonGenerator
@Deprecated public JsonGenerator setFeatureMask(int newMask)
JsonGenerator
JsonGenerator.Feature
ssetFeatureMask
in class JsonGenerator
newMask
- Bitmask that defines which JsonGenerator.Feature
s are enabled
and which disabledpublic JsonGenerator overrideStdFeatures(int values, int mask)
JsonGenerator
mask
.
Functionally equivalent to
int oldState = getFeatureMask();
int newState = (oldState & ~mask) | (values & mask);
setFeatureMask(newState);
but preferred as this lets caller more efficiently specify actual changes made.overrideStdFeatures
in class JsonGenerator
values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to changeprotected void _checkStdFeatureChanges(int newFeatureFlags, int changedFeatures)
newFeatureFlags
- Bitflag of standard features after they were changedchangedFeatures
- Bitflag of standard features for which setting
did changepublic JsonGenerator useDefaultPrettyPrinter()
JsonGenerator
DefaultPrettyPrinter
).useDefaultPrettyPrinter
in class JsonGenerator
public JsonGenerator setCodec(ObjectCodec oc)
JsonGenerator
JsonGenerator.writeObject(java.lang.Object)
).setCodec
in class JsonGenerator
public ObjectCodec getCodec()
JsonGenerator
JsonGenerator.writeObject(java.lang.Object)
).getCodec
in class JsonGenerator
public JsonStreamContext getOutputContext()
getOutputContext
in class JsonGenerator
public void writeStartObject(Object forValue) throws IOException
JsonGenerator
Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartObject
in class JsonGenerator
IOException
public void writeFieldName(SerializableString name) throws IOException
JsonGenerator
JsonGenerator.writeFieldName(String)
, main difference
being that it may perform better as some of processing (such as
quoting of certain characters, or encoding into external encoding
if supported by generator) can be done just once and reused for
later calls.
Default implementation simple uses unprocessed name container in serialized String; implementations are strongly encouraged to make use of more efficient methods argument object has.
writeFieldName
in class JsonGenerator
IOException
public void writeString(SerializableString text) throws IOException
JsonGenerator
JsonGenerator.writeString(String)
, but that takes
SerializableString
which can make this potentially
more efficient to call as generator may be able to reuse
quoted and/or encoded representation.
Default implementation just calls JsonGenerator.writeString(String)
;
sub-classes should override it with more efficient implementation
if possible.
writeString
in class JsonGenerator
IOException
public void writeRawValue(String text) throws IOException
JsonGenerator
writeRawValue
in class JsonGenerator
IOException
public void writeRawValue(String text, int offset, int len) throws IOException
writeRawValue
in class JsonGenerator
IOException
public void writeRawValue(char[] text, int offset, int len) throws IOException
writeRawValue
in class JsonGenerator
IOException
public void writeRawValue(SerializableString text) throws IOException
JsonGenerator
JsonGenerator.writeRawValue(String)
, but potentially more
efficient as it may be able to use pre-encoded content (similar to
JsonGenerator.writeRaw(SerializableString)
.writeRawValue
in class JsonGenerator
IOException
public int writeBinary(Base64Variant b64variant, InputStream data, int dataLength) throws IOException
JsonGenerator
JsonGenerator.writeBinary(Base64Variant,byte[],int,int)
,
but where input is provided through a stream, allowing for incremental
writes without holding the whole input in memory.writeBinary
in class JsonGenerator
b64variant
- Base64 variant to usedata
- InputStream to use for reading binary data to write.
Will not be closed after successful write operationdataLength
- (optional) number of bytes that will be available;
or -1 to be indicate it is not known.
If a positive length is given, data
MUST provide at least
that many bytes: if not, an exception will be thrown.
Note that implementations
need not support cases where length is not known in advance; this
depends on underlying data format: JSON output does NOT require length,
other formats may.data
and written as binary payloadIOException
public void writeObject(Object value) throws IOException
JsonGenerator
writeObject
in class JsonGenerator
IOException
public void writeTree(TreeNode rootNode) throws IOException
JsonGenerator
JsonGenerator.writeObject(java.lang.Object)
with given node, but is added
for convenience and to make code more explicit in cases
where it deals specifically with trees.writeTree
in class JsonGenerator
IOException
public abstract void flush() throws IOException
JsonGenerator
flush
in interface Flushable
flush
in class JsonGenerator
IOException
public void close() throws IOException
JsonGenerator
Whether the underlying target (stream, writer) gets closed depends
on whether this generator either manages the target (i.e. is the
only one with access to the target -- case if caller passes a
reference to the resource such as File, but not stream); or
has feature JsonGenerator.Feature.AUTO_CLOSE_TARGET
enabled.
If either of above is true, the target is also closed. Otherwise
(not managing, feature not enabled), target is not closed.
close
in interface Closeable
close
in interface AutoCloseable
close
in class JsonGenerator
IOException
public boolean isClosed()
JsonGenerator
isClosed
in class JsonGenerator
protected abstract void _releaseBuffers()
protected abstract void _verifyValueWrite(String typeMsg) throws IOException
typeMsg
- Additional message used for generating exception message
if value output is NOT legal in current generator output state.IOException
protected PrettyPrinter _constructDefaultPrettyPrinter()
PrettyPrinter
for case of "just use the default one", when useDefaultPrettyPrinter()
is called.protected final int _decodeSurrogate(int surr1, int surr2) throws IOException
IOException
Copyright © 2008-2016 FasterXML. All Rights Reserved.