Class JsonWriter
java.lang.Object
org.apache.logging.log4j.layout.template.json.util.JsonWriter
- All Implemented Interfaces:
AutoCloseable,Cloneable
A simple JSON writer with support for common Java data types.
The following types have specific handlers:
- null input
Map,IndexedReadOnlyStringMap,StringMapCollectionandListNumber(BigDecimal,BigInteger,Float,Double,Byte,Short,Integer, andLong)BooleanStringBuilderFormattable- arrays of primitive types
char/boolean/byte/short/int/long/float/double and
Object CharSequenceand char[] with necessary escaping
JSON standard quoting routines are borrowed from Jackson.
Note that this class provides no protection against recursive collections, e.g., an array where one or more elements reference to the array itself.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int[]Lookup table used for determining which output characters in 7-bit ASCII range (i.e., first 128 Unicode code points, single-byte UTF-8 characters) need to be quoted.private final StringBuilderprivate static final char[]private final intprivate final char[]private final Stringprivate final StringBuilderprivate final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()voidclose()intstatic JsonWriter.Builderprivate intquoteNamed(int esc) private intquoteNumeric(int value) private voidquoteString(char[] buffer, int offset, int length) Quote text contents using JSON standard quoting.private voidquoteString(CharSequence seq, int offset, int length) Quote text contents using JSON standard quoting.private StringquoteString(String string) private voidtrimStringBuilder(StringBuilder stringBuilder, int length) voidwriteArray(boolean[] items) voidwriteArray(byte[] items) voidwriteArray(char[] items) voidwriteArray(double[] items) voidwriteArray(float[] items) voidwriteArray(int[] items) voidwriteArray(long[] items) voidwriteArray(short[] items) voidwriteArray(Object[] items) voidwriteArray(Collection<Object> items) voidwriteArray(List<Object> items) voidvoidvoidwriteBoolean(boolean value) voidvoidwriteNumber(double number) voidwriteNumber(float number) voidwriteNumber(int number) voidwriteNumber(long number) voidwriteNumber(long integralPart, long fractionalPart) voidwriteNumber(short number) private voidwriteNumber(Number number) voidwriteNumber(BigDecimal number) voidwriteNumber(BigInteger number) voidwriteObject(Map<String, Object> map) voidvoidwriteObject(StringMap map) voidvoidvoidvoidwriteRawString(char[] buffer) voidwriteRawString(char[] buffer, int offset, int length) voidvoidwriteRawString(CharSequence seq, int offset, int length) voidvoidwriteString(char[] buffer) voidwriteString(char[] buffer, int offset, int length) voidwriteString(CharSequence seq) voidwriteString(CharSequence seq, int offset, int length) <S> voidwriteString(BiConsumer<StringBuilder, S> emitter, S state) voidwriteString(StringBuilderFormattable formattable) voidwriteValue(Object value)
-
Field Details
-
HEX_CHARS
private static final char[] HEX_CHARS -
ESC_CODES
private static final int[] ESC_CODESLookup table used for determining which output characters in 7-bit ASCII range (i.e., first 128 Unicode code points, single-byte UTF-8 characters) need to be quoted.Value of 0 means "no escaping"; other positive values, that value is character to use after backslash; and negative values, that generic (backslash - u) escaping is to be used.
-
quoteBuffer
private final char[] quoteBuffer -
stringBuilder
-
formattableBuffer
-
maxStringLength
private final int maxStringLength -
truncatedStringSuffix
-
quotedTruncatedStringSuffix
-
-
Constructor Details
-
JsonWriter
-
-
Method Details
-
quoteString
-
use
-
getStringBuilder
-
getMaxStringLength
public int getMaxStringLength() -
getTruncatedStringSuffix
-
writeValue
-
writeObject
-
writeObject
-
writeObject
-
writeObjectStart
public void writeObjectStart() -
writeObjectEnd
public void writeObjectEnd() -
writeObjectKey
-
writeArray
-
writeArray
-
writeArray
public void writeArray(char[] items) -
writeArray
public void writeArray(boolean[] items) -
writeArray
public void writeArray(byte[] items) -
writeArray
public void writeArray(short[] items) -
writeArray
public void writeArray(int[] items) -
writeArray
public void writeArray(long[] items) -
writeArray
public void writeArray(float[] items) -
writeArray
public void writeArray(double[] items) -
writeArray
-
writeArrayStart
public void writeArrayStart() -
writeArrayEnd
public void writeArrayEnd() -
writeSeparator
public void writeSeparator() -
writeString
-
writeString
-
writeString
-
writeString
-
quoteString
Quote text contents using JSON standard quoting. -
writeString
public void writeString(char[] buffer) -
writeString
public void writeString(char[] buffer, int offset, int length) -
quoteString
private void quoteString(char[] buffer, int offset, int length) Quote text contents using JSON standard quoting. -
quoteNumeric
private int quoteNumeric(int value) -
quoteNamed
private int quoteNamed(int esc) -
writeNumber
-
writeNumber
-
writeNumber
-
writeNumber
public void writeNumber(float number) -
writeNumber
public void writeNumber(double number) -
writeNumber
public void writeNumber(short number) -
writeNumber
public void writeNumber(int number) -
writeNumber
public void writeNumber(long number) -
writeNumber
public void writeNumber(long integralPart, long fractionalPart) -
writeBoolean
public void writeBoolean(boolean value) -
writeNull
public void writeNull() -
writeRawString
-
writeRawString
-
writeRawString
public void writeRawString(char[] buffer) -
writeRawString
public void writeRawString(char[] buffer, int offset, int length) -
close
public void close()- Specified by:
closein interfaceAutoCloseable
-
trimStringBuilder
-
clone
-
newBuilder
-