com.cedarsoftware.util.io

Interface JsonWriter.JsonClassWriter

All Superinterfaces:

JsonWriter.JsonClassWriterBase

All Known Implementing Classes:

Writers.AtomicBooleanWriter, Writers.AtomicIntegerWriter, Writers.AtomicLongWriter, Writers.BigDecimalWriter, Writers.BigIntegerWriter, Writers.CalendarWriter, Writers.ClassWriter, Writers.DateWriter, Writers.JsonStringWriter, Writers.LocaleWriter, Writers.StringBufferWriter, Writers.StringBuilderWriter, Writers.TimestampWriter, Writers.TimeZoneWriter, Writers.UUIDWriter

Enclosing class:

JsonWriter

public static interface JsonWriter.JsonClassWriter
extends JsonWriter.JsonClassWriterBase

Implement this interface to customize the JSON output for a given class.

Method Summary

Modifier and Type	Method and Description
boolean	hasPrimitiveForm()
void	write(Object o, boolean showType, Writer output) When write() is called, it is expected that subclasses will write the appropriate JSON to the passed in Writer.
void	writePrimitiveForm(Object o, Writer output) This method will be called to write the item in primitive form (if the response to hasPrimitiveForm() was true).

Method Detail

write

void write(Object o,
           boolean showType,
           Writer output)
    throws IOException

When write() is called, it is expected that subclasses will write the appropriate JSON to the passed in Writer.

Parameters:

o - Object to be written in JSON format.

showType - boolean indicating whether to show @type.

output - Writer destination to where the actual JSON is written.

Throws:

IOException - if thrown by the writer. Will be caught at a higher level and wrapped in JsonIoException.

hasPrimitiveForm

boolean hasPrimitiveForm()

Returns:

boolean true if the class being written has a primitive (non-object) form.

writePrimitiveForm

void writePrimitiveForm(Object o,
                        Writer output)
                 throws IOException

This method will be called to write the item in primitive form (if the response to hasPrimitiveForm() was true).

Parameters:

o - Object to be written

output - Writer destination to where the actual JSON is written.

Throws:

IOException - if thrown by the writer. Will be caught at a higher level and wrapped in JsonIoException.