org.fossnova.json.stream

Interface JsonWriter

All Superinterfaces:

java.lang.AutoCloseable, java.io.Flushable

public interface JsonWriter
extends java.io.Flushable, java.lang.AutoCloseable

JSON writer.

Author:

Richard Opalka

See Also:

JsonStreamFactory

Method Summary

Modifier and Type	Method and Description
void	close() Free resources associated with this writer.
void	flush() Writes all cached data.
JsonWriter	writeArrayEnd() Writes JSON array end token.
JsonWriter	writeArrayStart() Writes JSON array start token.
JsonWriter	writeBigDecimal(java.math.BigDecimal data) Writes JSON number.
JsonWriter	writeBigInteger(java.math.BigInteger data) Writes JSON number.
JsonWriter	writeBoolean(boolean data) Writes JSON true or false token.
JsonWriter	writeByte(byte data) Writes JSON number.
JsonWriter	writeDouble(double data) Writes JSON number.
JsonWriter	writeFloat(float data) Writes JSON number.
JsonWriter	writeInt(int data) Writes JSON number.
JsonWriter	writeLong(long data) Writes JSON number.
JsonWriter	writeNull() Writes JSON null token.
JsonWriter	writeObjectEnd() Writes JSON object end token.
JsonWriter	writeObjectStart() Writes JSON object start token.
JsonWriter	writeShort(short data) Writes JSON number.
JsonWriter	writeString(java.lang.String data) Writes JSON string.

Method Detail

writeObjectStart

JsonWriter writeObjectStart()
                     throws java.io.IOException,
                            JsonException

Writes JSON object start token.

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeObjectEnd

JsonWriter writeObjectEnd()
                   throws java.io.IOException,
                          JsonException

Writes JSON object end token.

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeArrayStart

JsonWriter writeArrayStart()
                    throws java.io.IOException,
                           JsonException

Writes JSON array start token.

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeArrayEnd

JsonWriter writeArrayEnd()
                  throws java.io.IOException,
                         JsonException

Writes JSON array end token.

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeNull

JsonWriter writeNull()
              throws java.io.IOException,
                     JsonException

Writes JSON null token.

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeString

JsonWriter writeString(java.lang.String data)
                throws java.io.IOException,
                       JsonException

Writes JSON string.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeBoolean

JsonWriter writeBoolean(boolean data)
                 throws java.io.IOException,
                        JsonException

Writes JSON true or false token.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeByte

JsonWriter writeByte(byte data)
              throws java.io.IOException,
                     JsonException

Writes JSON number.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeShort

JsonWriter writeShort(short data)
               throws java.io.IOException,
                      JsonException

Writes JSON number.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeInt

JsonWriter writeInt(int data)
             throws java.io.IOException,
                    JsonException

Writes JSON number.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeLong

JsonWriter writeLong(long data)
              throws java.io.IOException,
                     JsonException

Writes JSON number.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeBigInteger

JsonWriter writeBigInteger(java.math.BigInteger data)
                    throws java.io.IOException,
                           JsonException

Writes JSON number.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeBigDecimal

JsonWriter writeBigDecimal(java.math.BigDecimal data)
                    throws java.io.IOException,
                           JsonException

Writes JSON number.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeFloat

JsonWriter writeFloat(float data)
               throws java.io.IOException,
                      JsonException

Writes JSON number.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeDouble

JsonWriter writeDouble(double data)
                throws java.io.IOException,
                       JsonException

Writes JSON number.

Parameters:

data - to encode

Returns:

this writer instance

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

flush

void flush()
    throws java.io.IOException

Writes all cached data.

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException - if some I/O error occurs

close

void close()
    throws java.io.IOException,
           JsonException

Free resources associated with this writer. Closes underlying output stream or writer.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected