Class GeneratorBase
- All Implemented Interfaces:
Versioned
,Closeable
,Flushable
,AutoCloseable
- Direct Known Subclasses:
JsonGeneratorImpl
-
Nested Class Summary
Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonGenerator
JsonGenerator.Feature
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
Flag set to indicate that implicit conversion from number to JSON String is needed (as perJsonWriteFeature.WRITE_NUMBERS_AS_STRINGS
).protected boolean
Flag that indicates whether generator is closed or not.protected int
Bit flag composed of bits that indicate whichJsonGenerator.Feature
s are enabled.protected ObjectCodec
protected JsonWriteContext
Object that keeps track of the current contextual state of the generator.protected static final int
Set of feature masks related to features that need updates of other local configuration or state.protected static final int
This value is the limit of scale allowed for serializingBigDecimal
in "plain" (non-engineering) notation; intent is to prevent asymmetric attack whereupon simple eng-notation with big scale is used to generate huge "plain" serialization.static final int
static final int
static final int
static final int
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonGenerator
_cfgPrettyPrinter, DEFAULT_BINARY_WRITE_CAPABILITIES, DEFAULT_TEXTUAL_WRITE_CAPABILITIES, DEFAULT_WRITE_CAPABILITIES
-
Constructor Summary
ModifierConstructorDescriptionprotected
GeneratorBase
(int features, ObjectCodec codec) protected
GeneratorBase
(int features, ObjectCodec codec, JsonWriteContext ctxt) -
Method Summary
Modifier and TypeMethodDescriptionprotected String
_asString
(BigDecimal value) Helper method used to serialize aBigDecimal
as a String, for serialization, taking into account configuration settingsprotected void
_checkRangeBoundsForByteArray
(byte[] data, int offset, int len) protected void
_checkRangeBoundsForCharArray
(char[] data, int offset, int len) protected void
_checkRangeBoundsForString
(String data, int offset, int len) protected void
_checkStdFeatureChanges
(int newFeatureFlags, int changedFeatures) Helper method called to verify changes to standard features.protected PrettyPrinter
Overridable factory method called to instantiate an appropriatePrettyPrinter
for case of "just use the default one", whenuseDefaultPrettyPrinter()
is called.protected final int
_decodeSurrogate
(int surr1, int surr2) protected abstract void
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.Method for disabling specified feature (checkJsonGenerator.Feature
for list of features)Method for enabling specified generator feature: checkJsonGenerator.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.getCodec()
Method for accessing the object used for writing Java object as JSON content (using methodJsonGenerator.writeObject(java.lang.Object)
).Alias forJsonGenerator.currentValue()
, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).int
Bulk access method for getting state of all standard (non-dataformat-specific)JsonGenerator.Feature
s.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.final boolean
Method for checking whether given feature is enabled.overrideStdFeatures
(int values, int mask) Bulk set method for (re)setting states of features specified bymask
.setCodec
(ObjectCodec oc) Method that can be called to set or reset the object to use for writing Java objects as JsonContent (using methodJsonGenerator.writeObject(java.lang.Object)
).void
Alias forJsonGenerator.assignCurrentValue(java.lang.Object)
, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).setFeatureMask
(int newMask) Deprecated.Convenience method for enabling pretty-printing using the default pretty printer (DefaultPrettyPrinter
).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 toJsonGenerator.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
Method similar toJsonGenerator.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) Older alias forJsonGenerator.writePOJO(Object)
void
writeRawValue
(char[] text, int offset, int len) void
Method similar toJsonGenerator.writeRawValue(String)
, but potentially more efficient as it may be able to use pre-encoded content (similar toJsonGenerator.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 an Object value to represent the given Java Object value.void
Method similar toJsonGenerator.writeString(String)
, but that takesSerializableString
which can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.void
Method for writing given JSON tree (expressed as a tree where given JsonNode is the root) using this generator.Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonGenerator
_copyCurrentContents, _reportError, _reportUnsupportedOperation, _throwInternal, _verifyOffsets, _writeSimpleObject, assignCurrentValue, canOmitFields, canUseSchema, canWriteBinaryNatively, canWriteFormattedNumbers, canWriteObjectId, canWriteTypeId, configure, copyCurrentEvent, copyCurrentStructure, currentValue, getCharacterEscapes, getFormatFeatures, getHighestEscapedChar, getOutputBuffered, getOutputTarget, getPrettyPrinter, getSchema, getWriteCapabilities, isEnabled, overrideFormatFeatures, setCharacterEscapes, setHighestNonEscapedChar, setPrettyPrinter, setRootValueSeparator, setSchema, writeArray, 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, writeNumber, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeObjectId, writeObjectRef, writeOmittedField, writePOJO, writePOJOField, writeRaw, writeRaw, writeRaw, writeRaw, writeRaw, writeRawUTF8String, writeStartArray, writeStartArray, writeStartArray, writeStartArray, writeStartObject, writeStartObject, writeString, writeString, writeString, writeStringField, writeTypeId, writeTypePrefix, writeTypeSuffix, writeUTF8String
-
Field Details
-
SURR1_FIRST
public static final int SURR1_FIRST- See Also:
-
SURR1_LAST
public static final int SURR1_LAST- See Also:
-
SURR2_FIRST
public static final int SURR2_FIRST- See Also:
-
SURR2_LAST
public static final int SURR2_LAST- See Also:
-
DERIVED_FEATURES_MASK
protected static final int DERIVED_FEATURES_MASKSet of feature masks related to features that need updates of other local configuration or state.- Since:
- 2.5
-
WRITE_BINARY
- See Also:
-
WRITE_BOOLEAN
- See Also:
-
WRITE_NULL
- See Also:
-
WRITE_NUMBER
- See Also:
-
WRITE_RAW
- See Also:
-
WRITE_STRING
- See Also:
-
MAX_BIG_DECIMAL_SCALE
protected static final int MAX_BIG_DECIMAL_SCALEThis value is the limit of scale allowed for serializingBigDecimal
in "plain" (non-engineering) notation; intent is to prevent asymmetric attack whereupon simple eng-notation with big scale is used to generate huge "plain" serialization. See [core#315] for details.- Since:
- 2.7.7
- See Also:
-
_objectCodec
-
_features
protected int _featuresBit flag composed of bits that indicate whichJsonGenerator.Feature
s are enabled. -
_cfgNumbersAsStrings
protected boolean _cfgNumbersAsStringsFlag set to indicate that implicit conversion from number to JSON String is needed (as perJsonWriteFeature.WRITE_NUMBERS_AS_STRINGS
). -
_writeContext
Object that keeps track of the current contextual state of the generator. -
_closed
protected boolean _closedFlag that indicates whether generator is closed or not. Gets set when it is closed by an explicit call (close()
).
-
-
Constructor Details
-
GeneratorBase
-
GeneratorBase
-
-
Method Details
-
version
Implemented with standard version number detection algorithm, typically using a simple generated class, with information extracted from Maven project file during build.- Specified by:
version
in interfaceVersioned
- Specified by:
version
in classJsonGenerator
- Returns:
- Version number of the generator (version of the jar that contains generator implementation class)
-
getCurrentValue
Description copied from class:JsonGenerator
Alias forJsonGenerator.currentValue()
, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).- Overrides:
getCurrentValue
in classJsonGenerator
- Returns:
- Location of the last processed input unit (byte or character)
-
setCurrentValue
Description copied from class:JsonGenerator
Alias forJsonGenerator.assignCurrentValue(java.lang.Object)
, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).- Overrides:
setCurrentValue
in classJsonGenerator
- Parameters:
v
- Current value to assign for the current context of this generator
-
isEnabled
Description copied from class:JsonGenerator
Method for checking whether given feature is enabled. CheckJsonGenerator.Feature
for list of available features.- Specified by:
isEnabled
in classJsonGenerator
- Parameters:
f
- Feature to check- Returns:
- True if specified feature is enabled; false if not
-
getFeatureMask
public int getFeatureMask()Description copied from class:JsonGenerator
Bulk access method for getting state of all standard (non-dataformat-specific)JsonGenerator.Feature
s.- Specified by:
getFeatureMask
in classJsonGenerator
- Returns:
- Bit mask that defines current states of all standard
JsonGenerator.Feature
s.
-
enable
Description copied from class:JsonGenerator
Method for enabling specified generator feature: checkJsonGenerator.Feature
for list of available features.- Specified by:
enable
in classJsonGenerator
- Parameters:
f
- Feature to enable- Returns:
- This generator, to allow call chaining
-
disable
Description copied from class:JsonGenerator
Method for disabling specified feature (checkJsonGenerator.Feature
for list of features)- Specified by:
disable
in classJsonGenerator
- Parameters:
f
- Feature to disable- Returns:
- This generator, to allow call chaining
-
setFeatureMask
Deprecated.Description copied from class:JsonGenerator
Bulk set method for (re)setting states of all standardJsonGenerator.Feature
s- Specified by:
setFeatureMask
in classJsonGenerator
- Parameters:
newMask
- Bitmask that defines whichJsonGenerator.Feature
s are enabled and which disabled- Returns:
- This generator, to allow call chaining
-
overrideStdFeatures
Description copied from class:JsonGenerator
Bulk set method for (re)setting states of features specified bymask
. Functionally equivalent toint oldState = getFeatureMask(); int newState = (oldState & ~mask) | (values & mask); setFeatureMask(newState);
but preferred as this lets caller more efficiently specify actual changes made.- Overrides:
overrideStdFeatures
in classJsonGenerator
- Parameters:
values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to change- Returns:
- This generator, to allow call chaining
-
_checkStdFeatureChanges
protected void _checkStdFeatureChanges(int newFeatureFlags, int changedFeatures) Helper method called to verify changes to standard features.- Parameters:
newFeatureFlags
- Bitflag of standard features after they were changedchangedFeatures
- Bitflag of standard features for which setting did change- Since:
- 2.7
-
useDefaultPrettyPrinter
Description copied from class:JsonGenerator
Convenience method for enabling pretty-printing using the default pretty printer (DefaultPrettyPrinter
).- Specified by:
useDefaultPrettyPrinter
in classJsonGenerator
- Returns:
- This generator, to allow call chaining
-
setCodec
Description copied from class:JsonGenerator
Method that can be called to set or reset the object to use for writing Java objects as JsonContent (using methodJsonGenerator.writeObject(java.lang.Object)
).- Specified by:
setCodec
in classJsonGenerator
- Parameters:
oc
- Codec to assign, if any;null
if none- Returns:
- This generator, to allow call chaining
-
getCodec
Description copied from class:JsonGenerator
Method for accessing the object used for writing Java object as JSON content (using methodJsonGenerator.writeObject(java.lang.Object)
).- Specified by:
getCodec
in classJsonGenerator
- Returns:
- Codec assigned to this generator, if any;
null
if none
-
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.- Specified by:
getOutputContext
in classJsonGenerator
- Returns:
- Stream output context (
JsonStreamContext
) associated with this generator
-
writeStartObject
Description copied from class:JsonGenerator
Method for writing starting marker of an Object value to represent the given Java Object value. Argument is offered as metadata, but more importantly it should be assigned as the "current value" for the Object content that gets constructed and initialized.Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
- Overrides:
writeStartObject
in classJsonGenerator
- Parameters:
forValue
- "Current value" to assign for the Object context being created- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeFieldName
Description copied from class:JsonGenerator
Method similar toJsonGenerator.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.
- Specified by:
writeFieldName
in classJsonGenerator
- Parameters:
name
- Field name to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeString
Description copied from class:JsonGenerator
Method similar toJsonGenerator.writeString(String)
, but that takesSerializableString
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.- Specified by:
writeString
in classJsonGenerator
- Parameters:
text
- Pre-encoded String value to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRawValue
Description copied from class:JsonGenerator
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). Assuming this, proper separators are added if and as needed (comma or colon), and generator state updated to reflect this.- Specified by:
writeRawValue
in classJsonGenerator
- Parameters:
text
- Textual contents to included in output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRawValue
- Specified by:
writeRawValue
in classJsonGenerator
- Throws:
IOException
-
writeRawValue
- Specified by:
writeRawValue
in classJsonGenerator
- Throws:
IOException
-
writeRawValue
Description copied from class:JsonGenerator
Method similar toJsonGenerator.writeRawValue(String)
, but potentially more efficient as it may be able to use pre-encoded content (similar toJsonGenerator.writeRaw(SerializableString)
.- Overrides:
writeRawValue
in classJsonGenerator
- Parameters:
text
- Pre-encoded textual contents to included in output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeBinary
public int writeBinary(Base64Variant b64variant, InputStream data, int dataLength) throws IOException Description copied from class:JsonGenerator
Method similar toJsonGenerator.writeBinary(Base64Variant,byte[],int,int)
, but where input is provided through a stream, allowing for incremental writes without holding the whole input in memory.- Specified by:
writeBinary
in classJsonGenerator
- Parameters:
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.- Returns:
- Number of bytes read from
data
and written as binary payload - Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeObject
Description copied from class:JsonGenerator
Older alias forJsonGenerator.writePOJO(Object)
- Specified by:
writeObject
in classJsonGenerator
- Parameters:
value
- Java value (usually POJO) to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeTree
Description copied from class:JsonGenerator
Method for writing given JSON tree (expressed as a tree where given JsonNode is the root) using this generator. This will generally just callJsonGenerator.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.- Specified by:
writeTree
in classJsonGenerator
- Parameters:
rootNode
-TreeNode
to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
flush
Description copied from class:JsonGenerator
Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.- Specified by:
flush
in interfaceFlushable
- Specified by:
flush
in classJsonGenerator
- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
close
Description copied from class:JsonGenerator
Method called to close this generator, so that no more content can be written.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.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classJsonGenerator
- Throws:
IOException
- if there is either an underlying I/O problem
-
isClosed
public boolean isClosed()Description copied from class:JsonGenerator
Method that can be called to determine whether this generator is closed or not. If it is closed, no more output can be done.- Specified by:
isClosed
in classJsonGenerator
- Returns:
True
if this generator instance has been closed
-
_releaseBuffers
protected abstract void _releaseBuffers()Method called to release any buffers generator may be holding, once generator is being closed. -
_verifyValueWrite
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.- Parameters:
typeMsg
- Additional message used for generating exception message if value output is NOT legal in current generator output state.- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
_constructDefaultPrettyPrinter
Overridable factory method called to instantiate an appropriatePrettyPrinter
for case of "just use the default one", whenuseDefaultPrettyPrinter()
is called.- Returns:
- Instance of "default" pretty printer to use
- Since:
- 2.6
-
_asString
Helper method used to serialize aBigDecimal
as a String, for serialization, taking into account configuration settings- Parameters:
value
- BigDecimal value to convert to String- Returns:
- String representation of
value
- Throws:
IOException
- if there is a problem serializing value as String- Since:
- 2.7.7
-
_decodeSurrogate
- Throws:
IOException
-
_checkRangeBoundsForByteArray
- Throws:
IOException
-
_checkRangeBoundsForCharArray
- Throws:
IOException
-
_checkRangeBoundsForString
- Throws:
IOException
-