Module de.ralleytn.simple.json

Package de.ralleytn.simple.json

Interface JSONContentHandler

public interface JSONContentHandler

A simplified and stoppable SAX-like content handler for stream processing of JSON text.

Since:

1.0.0

Version:

1.0.0

Author:

FangYidong(fangyidong@yahoo.com.cn)

See Also:

• org.xml.sax.ContentHandler
• JSONParser.parse(java.io.Reader, JSONContentHandler, boolean)

Method Summary

Modifier and Type	Method	Description
boolean	endArray()	Receives a notification when a JSON array ends.
void	endJSON()	Receives a notification when the JSON processing ends.
boolean	endObject()	Receives a notification when a JSON object ends.
boolean	endObjectEntry()	Receives a notification when a JSON entry ends.
boolean	primitive(Object value)	Receives a notification when a primitive JSON value is reached: String Number Boolean null
boolean	startArray()	Receives a notification when a JSON array begins.
void	startJSON()	Receives a notification when the JSON processing begins.
boolean	startObject()	Receives a notification when a JSON object begins.
boolean	startObjectEntry(String key)	Receives a notification when a JSON object entry begins.

Method Details

startJSON

void startJSON()
        throws JSONParseException,
IOException

Receives a notification when the JSON processing begins. The JSONParser will invoke this method only once.

Throws:

JSONParseException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

IOException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

Since:

1.0.0

endJSON

void endJSON()
      throws JSONParseException,
IOException

Receives a notification when the JSON processing ends.

Throws:

JSONParseException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

IOException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

Since:

1.0.0

startObject

boolean startObject()
             throws JSONParseException,
IOException

Receives a notification when a JSON object begins.

Returns:

false if the JSONContentHandler wants to stop parsing after return

Throws:

JSONParseException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

IOException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

Since:

1.0.0

See Also:

• endJSON()

endObject

boolean endObject()
           throws JSONParseException,
IOException

Receives a notification when a JSON object ends.

Returns:

false if the JSONContentHandler wants to stop parsing after return

Throws:

JSONParseException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

IOException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

Since:

1.0.0

See Also:

• startObject()

startObjectEntry

boolean startObjectEntry(String key)
                  throws JSONParseException,
IOException

Receives a notification when a JSON object entry begins.

Parameters:

key - name of the object entry

Returns:

false if the JSONContentHandler wants to stop parsing after return

Throws:

JSONParseException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

IOException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

Since:

1.0.0

See Also:

• endObjectEntry()

endObjectEntry

boolean endObjectEntry()
                throws JSONParseException,
IOException

Receives a notification when a JSON entry ends.

Returns:

false if the JSONContentHandler wants to stop parsing after return

Throws:

JSONParseException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

IOException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

See Also:

• startObjectEntry(java.lang.String)

startArray

boolean startArray()
            throws JSONParseException,
IOException

Receives a notification when a JSON array begins.

Returns:

false if the JSONContentHandler wants to stop parsing after return

Throws:

JSONParseException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

IOException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

Since:

1.0.0

See Also:

• endArray()

endArray

boolean endArray()
          throws JSONParseException,
IOException

Receives a notification when a JSON array ends.

Returns:

false if the JSONContentHandler wants to stop parsing after return

Throws:

JSONParseException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

IOException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

Since:

1.0.0

See Also:

• startArray()

primitive

boolean primitive(Object value)
           throws JSONParseException,
IOException

Receives a notification when a primitive JSON value is reached:

• String
• Number
• Boolean
• null

Parameters:

value - the primitive JSON value

Returns:

false if the JSONContentHandler wants to stop parsing after return

Throws:

JSONParseException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

IOException - JSONParser will stop and throw the same Exception to the caller when receiving this Exception.

Since:

1.0.0