Modifier and Type	Class and Description
pack-priv static class	GenericRecordJsonWriter.AppendableWriter
protected static interface	GenericRecordJsonWriter.GenericRecordHandler

Modifier and Type	Field and Description
protected final GenericRecordJsonWriter.AppendableWriter	aw
protected int	childIndex
private static final Pattern	ESC_CHARS
protected final PrintWriter	fw
private static final List<Map.Entry<Class<?>, GenericRecordJsonWriter.GenericRecordHandler>>	handler
protected int	indent
private static final String	NL
private static final String	TABS
protected boolean	withComments
private static final String	ZEROS

Access	Constructor and Description
public	GenericRecordJsonWriter(File fileName)
public	GenericRecordJsonWriter(Appendable buffer)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
private static void	handler(Class<?> c, GenericRecordJsonWriter.GenericRecordHandler printer)
public static String	marshal(GenericRecord record)
public static String	marshal(GenericRecord record, boolean withComments)
protected static boolean	matchInstanceOrArray(Class<?> key, Object instance)
protected boolean	printAffineTransform(String name, Object o)
protected boolean	printAnnotatedFlag(String name, Object o)
protected boolean	printArray(String name, Object o)
protected boolean	printBoolean(String name, Object o)
protected boolean	printBytes(String name, Object o)
protected boolean	printColor(String name, Object o)
protected boolean	printDimension(String name, Object o)
protected boolean	printGenericRecord(String name, Object o)
protected boolean	printImage(String name, Object o)
protected boolean	printList(String name, Object o)
protected void	printName(String name)
protected boolean	printNull(String name, Object o)
protected boolean	printNumber(String name, Object o)
protected boolean	printObject(String name, Object o)
protected boolean	printPath(String name, Object o)
protected boolean	printPoint(String name, Object o)
protected boolean	printRectangle(String name, Object o)
public void	setWithComments(boolean withComments)
protected String	tabs()
pack-priv static String	trimHex(final long l, final int size)
public void	write(GenericRecord record)
protected boolean	writeChildren(GenericRecord record, boolean hasProperties)
public void	writeError(String errorMsg)
protected boolean	writeProp(String name, Supplier<?> value)
protected boolean	writeProperties(GenericRecord record)
protected boolean	writeValue(String name, Object o)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

aw	back to summary
protected final GenericRecordJsonWriter.AppendableWriter aw

childIndex	back to summary
protected int childIndex

ESC_CHARS	back to summary
private static final Pattern ESC_CHARS

fw	back to summary
protected final PrintWriter fw

handler	back to summary
private static final List<Map.Entry<Class<?>, GenericRecordJsonWriter.GenericRecordHandler>> handler

indent	back to summary
protected int indent

NL	back to summary
private static final String NL

TABS	back to summary
private static final String TABS

withComments	back to summary
protected boolean withComments

ZEROS	back to summary
private static final String ZEROS

GenericRecordJsonWriter	back to summary
public GenericRecordJsonWriter(File fileName) throws IOException

GenericRecordJsonWriter	back to summary
public GenericRecordJsonWriter(Appendable buffer)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

handler	back to summary
private static void handler(Class<?> c, GenericRecordJsonWriter.GenericRecordHandler printer)

marshal	back to summary
public static String marshal(GenericRecord record)

marshal	back to summary
public static String marshal(GenericRecord record, boolean withComments)

matchInstanceOrArray	back to summary
protected static boolean matchInstanceOrArray(Class<?> key, Object instance)

printAffineTransform	back to summary
protected boolean printAffineTransform(String name, Object o)

printAnnotatedFlag	back to summary
protected boolean printAnnotatedFlag(String name, Object o)

printArray	back to summary
protected boolean printArray(String name, Object o)

printBoolean	back to summary
protected boolean printBoolean(String name, Object o)

printBytes	back to summary
protected boolean printBytes(String name, Object o)

printColor	back to summary
protected boolean printColor(String name, Object o)

printDimension	back to summary
protected boolean printDimension(String name, Object o)

printGenericRecord	back to summary
protected boolean printGenericRecord(String name, Object o)

printImage	back to summary
protected boolean printImage(String name, Object o)

printList	back to summary
protected boolean printList(String name, Object o)

printName	back to summary
protected void printName(String name)

printNull	back to summary
protected boolean printNull(String name, Object o)

printNumber	back to summary
protected boolean printNumber(String name, Object o) Annotations @SuppressWarnings:java:S3516

printObject	back to summary
protected boolean printObject(String name, Object o)

printPath	back to summary
protected boolean printPath(String name, Object o)

printPoint	back to summary
protected boolean printPoint(String name, Object o)

printRectangle	back to summary
protected boolean printRectangle(String name, Object o)

setWithComments	back to summary
public void setWithComments(boolean withComments)

tabs	back to summary
protected String tabs()

trimHex	back to summary
pack-priv static String trimHex(final long l, final int size)

write	back to summary
public void write(GenericRecord record)

writeChildren	back to summary
protected boolean writeChildren(GenericRecord record, boolean hasProperties)

writeError	back to summary
public void writeError(String errorMsg)

writeProp	back to summary
protected boolean writeProp(String name, Supplier<?> value)

writeProperties	back to summary
protected boolean writeProperties(GenericRecord record)

writeValue	back to summary
protected boolean writeValue(String name, Object o)

org.apache.poi.util back to summary

pack-priv Class GenericRecordJsonWriter.AppendableWriter

Class Inheritance

extends Writer

java.lang.Object
java.io.Writer
org.apache.poi.util.GenericRecordJsonWriter.AppendableWriter

Field Summary

Modifier and Type	Field and Description
private final Appendable	appender
private String	holdBack
private final Writer	writer

Inherited from java.io.Writer:: lock

Constructor Summary

Access	Constructor and Description
pack-priv	AppendableWriter(Appendable buffer)
pack-priv	AppendableWriter(Writer writer)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Closes the stream, flushing it first.
public void	flush() Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Flushes the stream.
pack-priv void	setHoldBack(String holdBack)
public void	write(char[] Array of characters cbuf, int Offset from which to start writing characters off, int Number of characters to write len) Implements abstract java.io.Writer.write. Writes a portion of an array of characters.

Inherited from java.io.Writer:: append append append nullWriter write write write write

Field Detail

appender	back to summary
private final Appendable appender

holdBack	back to summary
private String holdBack

writer	back to summary
private final Writer writer

Constructor Detail

AppendableWriter	back to summary
pack-priv AppendableWriter(Appendable buffer)

AppendableWriter	back to summary
pack-priv AppendableWriter(Writer writer)

Method Detail

back to summary

public void close() throws IOException

Implements abstract java.io.Writer.close.

Implements java.io.Closeable.close.

Doc from java.io.Writer.close.

Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

flush

back to summary

public void flush() throws IOException

Implements abstract java.io.Writer.flush.

Implements java.io.Flushable.flush.

Doc from java.io.Writer.flush.

Flushes the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

setHoldBack	back to summary
pack-priv void setHoldBack(String holdBack)

write

back to summary

public void write(char[] cbuf, int off, int len) throws IOException

Implements abstract java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a portion of an array of characters.

Parameters

cbuf:char[]: Array of characters
off:int: Offset from which to start writing characters
len:int: Number of characters to write

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

org.apache.poi.util back to summary

protected Interface GenericRecordJsonWriter.GenericRecordHandler

Annotations

@FunctionalInterface

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true`, if the element was handled and output produced, The provided methods can be overridden and an implementation can return `false`, if the element hasn't been written to the stream print(GenericRecordJsonWriter the parent record, applied via instance method reference record, String the name of the property name, Object the value of the property object) Handler method

Method Detail

print back to summary

public boolean print(GenericRecordJsonWriter record, String name, Object object)

Handler method

Parameters

record:GenericRecordJsonWriter: the parent record, applied via instance method reference
name:String: the name of the property
object:Object: the value of the property

Returns:boolean

true, if the element was handled and output produced, The provided methods can be overridden and an implementation can return false, if the element hasn't been written to the stream

public Class GenericRecordJsonWriter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class GenericRecordJsonWriter.AppendableWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Interface GenericRecordJsonWriter.GenericRecordHandler

Method Summary

Method Detail