|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.codehaus.jackson.JsonGenerator
org.codehaus.jackson.impl.JsonGeneratorBase
org.codehaus.jackson.impl.Utf8Generator
public class Utf8Generator
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.codehaus.jackson.JsonGenerator |
|---|
JsonGenerator.Feature |
| Field Summary | |
|---|---|
protected char[] |
_charBuffer
Intermediate buffer in which characters of a String are copied before being encoded. |
protected int |
_charBufferLength
Length of _charBuffer |
protected byte[] |
_entityBuffer
6 character temporary buffer allocated if needed, for constructing escape sequences |
protected IOContext |
_ioContext
|
protected byte[] |
_outputBuffer
Intermediate buffer in which contents are buffered before being written using _outputStream. |
protected int |
_outputEnd
End marker of the output buffer; one past the last valid position within the buffer. |
protected int |
_outputMaxContiguous
Maximum number of chars that we know will always fit
in the output buffer after escaping |
protected OutputStream |
_outputStream
|
protected int |
_outputTail
Pointer to the position right beyond the last character to output (end marker; may be past the buffer) |
protected static int |
SURR1_FIRST
|
protected static int |
SURR1_LAST
|
protected static int |
SURR2_FIRST
|
protected static int |
SURR2_LAST
|
| Fields inherited from class org.codehaus.jackson.impl.JsonGeneratorBase |
|---|
_cfgNumbersAsStrings, _closed, _features, _objectCodec, _writeContext |
| Fields inherited from class org.codehaus.jackson.JsonGenerator |
|---|
_cfgPrettyPrinter |
| Constructor Summary | |
|---|---|
Utf8Generator(IOContext ctxt,
int features,
ObjectCodec codec,
OutputStream out)
|
|
| Method Summary | |
|---|---|
protected int |
_decodeSurrogate(int surr1,
int surr2)
|
protected void |
_flushBuffer()
|
protected void |
_outputSurrogates(int surr1,
int surr2)
|
protected void |
_releaseBuffers()
|
protected void |
_verifyPrettyValueWrite(String typeMsg,
int status)
|
protected void |
_verifyValueWrite(String typeMsg)
|
protected void |
_writeBinary(Base64Variant b64variant,
byte[] input,
int inputPtr,
int inputEnd)
|
protected void |
_writeFieldName(SerializableString name)
|
protected void |
_writeFieldName(String name)
|
protected void |
_writePPFieldName(SerializableString name,
boolean commaBefore)
|
protected void |
_writePPFieldName(String name,
boolean commaBefore)
Specialized version of _writeFieldName, off-lined
to keep the "fast path" as simple (and hopefully fast) as possible. |
void |
close()
Method called to close this generator, so that no more content can be written. |
void |
flush()
Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well. |
void |
writeBinary(Base64Variant b64variant,
byte[] data,
int offset,
int len)
Method that will output given chunk of binary data as base64 encoded, as a complete String value (surrounded by double quotes). |
void |
writeBoolean(boolean state)
Method for outputting literal Json boolean value (one of Strings 'true' and 'false'). |
void |
writeEndArray()
Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled). |
void |
writeEndObject()
Method for writing closing marker of a JSON Object value (character '}'; plus possible white space decoration if pretty-printing is enabled). |
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 |
writeFieldName(SerializedString 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 |
writeFieldName(String name)
Method for writing a field name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled. |
void |
writeNull()
Method for outputting literal Json null value. |
void |
writeNumber(BigDecimal value)
Method for outputting indicate Json numeric value. |
void |
writeNumber(BigInteger value)
Method for outputting given value as Json number. |
void |
writeNumber(double d)
Method for outputting indicate Json numeric value. |
void |
writeNumber(float f)
Method for outputting indicate Json numeric value. |
void |
writeNumber(int i)
Method for outputting given value as Json number. |
void |
writeNumber(long l)
Method for outputting given value as Json number. |
void |
writeNumber(String encodedValue)
Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types. |
void |
writeRaw(char ch)
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). |
void |
writeRaw(char[] cbuf,
int offset,
int len)
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). |
void |
writeRaw(String text)
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). |
void |
writeRaw(String text,
int offset,
int len)
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). |
void |
writeRawUTF8String(byte[] text,
int offset,
int length)
Method similar to JsonGenerator.writeString(String) but that takes as
its input a UTF-8 encoded String that is to be output as-is, without additional
escaping (type of which depends on data format; backslashes for JSON). |
void |
writeStartArray()
Method for writing starting marker of a JSON Array value (character '['; plus possible white space decoration if pretty-printing is enabled). |
void |
writeStartObject()
Method for writing starting marker of a JSON Object value (character '{'; plus possible white space decoration if pretty-printing is enabled). |
void |
writeString(char[] text,
int offset,
int len)
Method for outputting a String value. |
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 |
writeString(String text)
Method for outputting a String value. |
void |
writeStringField(String fieldName,
String value)
Convenience method for outputting a field entry ("member") that has a String value. |
void |
writeUTF8String(byte[] text,
int offset,
int len)
Method similar to JsonGenerator.writeString(String) but that takes as its input
a UTF-8 encoded String which has not been escaped using whatever
escaping scheme data format requires (for JSON that is backslash-escaping
for control characters and double-quotes; for other formats something else). |
| Methods inherited from class org.codehaus.jackson.impl.JsonGeneratorBase |
|---|
_cantHappen, _reportError, _reportUnsupportedOperation, _throwInternal, _writeEndArray, _writeEndObject, _writeSimpleObject, _writeStartArray, _writeStartObject, copyCurrentEvent, copyCurrentStructure, disable, enable, getCodec, getOutputContext, isClosed, isEnabled, setCodec, useDefaultPrettyPrinter, version, writeObject, writeRawValue, writeRawValue, writeRawValue, writeTree |
| Methods inherited from class org.codehaus.jackson.JsonGenerator |
|---|
configure, disableFeature, enableFeature, isFeatureEnabled, setFeature, setPrettyPrinter, writeArrayFieldStart, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected static final int SURR1_FIRST
protected static final int SURR1_LAST
protected static final int SURR2_FIRST
protected static final int SURR2_LAST
protected final IOContext _ioContext
protected final OutputStream _outputStream
protected byte[] _outputBuffer
_outputStream.
protected int _outputTail
protected final int _outputEnd
protected final int _outputMaxContiguous
chars that we know will always fit
in the output buffer after escaping
protected char[] _charBuffer
protected final int _charBufferLength
_charBuffer
protected byte[] _entityBuffer
| Constructor Detail |
|---|
public Utf8Generator(IOContext ctxt,
int features,
ObjectCodec codec,
OutputStream out)
| Method Detail |
|---|
public final void writeStringField(String fieldName,
String value)
throws IOException,
JsonGenerationException
JsonGeneratorwriteFieldName(fieldName); writeString(value);
Note: many performance-sensitive implementations override this method
writeStringField in class JsonGeneratorIOException
JsonGenerationException
public final void writeFieldName(String name)
throws IOException,
JsonGenerationException
JsonGeneratorField names can only be written in Object context (check out JSON specification for details), when field name is expected (field names alternate with values).
writeFieldName in class JsonGeneratorIOException
JsonGenerationException
public final void writeFieldName(SerializedString name)
throws IOException,
JsonGenerationException
JsonGeneratorJsonGenerator.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 JsonGeneratorIOException
JsonGenerationException
public final void writeFieldName(SerializableString name)
throws IOException,
JsonGenerationException
JsonGeneratorJsonGenerator.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 JsonGeneratorIOException
JsonGenerationException
public final void writeStartArray()
throws IOException,
JsonGenerationException
JsonGeneratorArray values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartArray in class JsonGeneratorBaseIOException
JsonGenerationException
public final void writeEndArray()
throws IOException,
JsonGenerationException
JsonGeneratorMarker can be written if the innermost structured type is Array.
writeEndArray in class JsonGeneratorBaseIOException
JsonGenerationException
public final void writeStartObject()
throws IOException,
JsonGenerationException
JsonGeneratorObject values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartObject in class JsonGeneratorBaseIOException
JsonGenerationException
public final void writeEndObject()
throws IOException,
JsonGenerationException
JsonGeneratorMarker can be written if the innermost structured type is Object, and the last written event was either a complete value, or START-OBJECT marker (see JSON specification for more details).
writeEndObject in class JsonGeneratorBaseIOException
JsonGenerationException
protected void _writeFieldName(String name)
throws IOException,
JsonGenerationException
IOException
JsonGenerationException
protected void _writeFieldName(SerializableString name)
throws IOException,
JsonGenerationException
IOException
JsonGenerationException
protected final void _writePPFieldName(String name,
boolean commaBefore)
throws IOException,
JsonGenerationException
_writeFieldName, off-lined
to keep the "fast path" as simple (and hopefully fast) as possible.
IOException
JsonGenerationException
protected final void _writePPFieldName(SerializableString name,
boolean commaBefore)
throws IOException,
JsonGenerationException
IOException
JsonGenerationException
public void writeString(String text)
throws IOException,
JsonGenerationException
JsonGenerator
writeString in class JsonGeneratorIOException
JsonGenerationException
public void writeString(char[] text,
int offset,
int len)
throws IOException,
JsonGenerationException
JsonGenerator
writeString in class JsonGeneratorIOException
JsonGenerationException
public final void writeString(SerializableString text)
throws IOException,
JsonGenerationException
JsonGeneratorJsonGenerator.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 JsonGeneratorIOException
JsonGenerationException
public void writeRawUTF8String(byte[] text,
int offset,
int length)
throws IOException,
JsonGenerationException
JsonGeneratorJsonGenerator.writeString(String) but that takes as
its input a UTF-8 encoded String that is to be output as-is, without additional
escaping (type of which depends on data format; backslashes for JSON).
However, quoting that data format requires (like double-quotes for JSON) will be added
around the value if and as necessary.
Note that some backends may choose not to support this method: for
example, if underlying destination is a Writer
using this method would require UTF-8 decoding.
If so, implementation may instead choose to throw a
UnsupportedOperationException due to ineffectiveness
of having to decode input.
writeRawUTF8String in class JsonGeneratorIOException
JsonGenerationException
public void writeUTF8String(byte[] text,
int offset,
int len)
throws IOException,
JsonGenerationException
JsonGeneratorJsonGenerator.writeString(String) but that takes as its input
a UTF-8 encoded String which has not been escaped using whatever
escaping scheme data format requires (for JSON that is backslash-escaping
for control characters and double-quotes; for other formats something else).
This means that textual JSON backends need to check if value needs
JSON escaping, but otherwise can just be copied as is to output.
Also, quoting that data format requires (like double-quotes for JSON) will be added
around the value if and as necessary.
Note that some backends may choose not to support this method: for
example, if underlying destination is a Writer
using this method would require UTF-8 decoding.
In this case
generator implementation may instead choose to throw a
UnsupportedOperationException due to ineffectiveness
of having to decode input.
writeUTF8String in class JsonGeneratorIOException
JsonGenerationException
public void writeRaw(String text)
throws IOException,
JsonGenerationException
JsonGeneratorJsonGenerator.writeRawValue(String) instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException.
writeRaw in class JsonGeneratorIOException
JsonGenerationException
public void writeRaw(String text,
int offset,
int len)
throws IOException,
JsonGenerationException
JsonGeneratorJsonGenerator.writeRawValue(String) instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException.
writeRaw in class JsonGeneratorIOException
JsonGenerationException
public final void writeRaw(char[] cbuf,
int offset,
int len)
throws IOException,
JsonGenerationException
JsonGeneratorJsonGenerator.writeRawValue(String) instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException.
writeRaw in class JsonGeneratorIOException
JsonGenerationException
public void writeRaw(char ch)
throws IOException,
JsonGenerationException
JsonGeneratorJsonGenerator.writeRawValue(String) instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException.
writeRaw in class JsonGeneratorIOException
JsonGenerationException
public void writeBinary(Base64Variant b64variant,
byte[] data,
int offset,
int len)
throws IOException,
JsonGenerationException
JsonGenerator
Note: because Json Strings can not contain unescaped linefeeds,
if linefeeds are included (as per last argument), they must be
escaped. This adds overhead for decoding without improving
readability.
Alternatively if linefeeds are not included,
resulting String value may violate the requirement of base64
RFC which mandates line-length of 76 characters and use of
linefeeds. However, all JsonParser implementations
are required to accept such "long line base64"; as do
typical production-level base64 decoders.
writeBinary in class JsonGeneratorb64variant - Base64 variant to use: defines details such as
whether padding is used (and if so, using which character);
what is the maximum line length before adding linefeed,
and also the underlying alphabet to use.
IOException
JsonGenerationException
public void writeNumber(int i)
throws IOException,
JsonGenerationException
JsonGenerator
writeNumber in class JsonGeneratorIOException
JsonGenerationException
public void writeNumber(long l)
throws IOException,
JsonGenerationException
JsonGenerator
writeNumber in class JsonGeneratorIOException
JsonGenerationException
public void writeNumber(BigInteger value)
throws IOException,
JsonGenerationException
JsonGenerator
writeNumber in class JsonGeneratorIOException
JsonGenerationException
public void writeNumber(double d)
throws IOException,
JsonGenerationException
JsonGenerator
writeNumber in class JsonGeneratorIOException
JsonGenerationException
public void writeNumber(float f)
throws IOException,
JsonGenerationException
JsonGenerator
writeNumber in class JsonGeneratorIOException
JsonGenerationException
public void writeNumber(BigDecimal value)
throws IOException,
JsonGenerationException
JsonGenerator
writeNumber in class JsonGeneratorIOException
JsonGenerationException
public void writeNumber(String encodedValue)
throws IOException,
JsonGenerationException
JsonGeneratorJsonGenerator.writeString(java.lang.String) method can not be used; nor
JsonGenerator.writeRaw(java.lang.String) because that does not properly handle
value separators needed in Array or Object contexts.
Note: because of lack of type safety, some generator
implementations may not be able to implement this
method. For example, if a binary json format is used,
it may require type information for encoding; similarly
for generator-wrappers around Java objects or Json nodes.
If implementation does not implement this method,
it needs to throw UnsupportedOperationException.
writeNumber in class JsonGeneratorIOException
JsonGenerationException
public void writeBoolean(boolean state)
throws IOException,
JsonGenerationException
JsonGenerator
writeBoolean in class JsonGeneratorIOException
JsonGenerationException
public void writeNull()
throws IOException,
JsonGenerationException
JsonGenerator
writeNull in class JsonGeneratorIOException
JsonGenerationException
protected final void _verifyValueWrite(String typeMsg)
throws IOException,
JsonGenerationException
_verifyValueWrite in class JsonGeneratorBaseIOException
JsonGenerationException
protected final void _verifyPrettyValueWrite(String typeMsg,
int status)
throws IOException,
JsonGenerationException
IOException
JsonGenerationException
public final void flush()
throws IOException
JsonGenerator
flush in class JsonGeneratorBaseIOException
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 Closeableclose in class JsonGeneratorBaseIOExceptionprotected void _releaseBuffers()
_releaseBuffers in class JsonGeneratorBase
protected void _writeBinary(Base64Variant b64variant,
byte[] input,
int inputPtr,
int inputEnd)
throws IOException,
JsonGenerationException
IOException
JsonGenerationException
protected final void _outputSurrogates(int surr1,
int surr2)
throws IOException
IOException
protected final int _decodeSurrogate(int surr1,
int surr2)
throws IOException
IOException
protected final void _flushBuffer()
throws IOException
IOException
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||