From 7f0c723dc4e8213d005e8d65342005580c6de53e Mon Sep 17 00:00:00 2001
From: fangyidong <fangyidong@b68fe964-5755-0410-a06c-9fee2ea08261>
Date: Sat, 31 Jan 2009 13:47:34 +0000
Subject: [PATCH] clarify some comments

---
 lib/json_simple-1.1.jar                       | Bin 16082 -> 16082 bytes
 .../json/simple/parser/ContentHandler.java    |  25 +++++++++++++-----
 2 files changed, 18 insertions(+), 7 deletions(-)

diff --git a/lib/json_simple-1.1.jar b/lib/json_simple-1.1.jar
index 840ead29fa05387c23d39ae5418cb669029b3f0b..a2b66071d0711777f4790914dc13e3457d9d5083 100644
GIT binary patch
delta 311
zcmcaqd#RQ;z?+$civa}M*V<3yRbg%eQYKx@Al^ZFF!fjkL`~*m)CSR;Eg0)qz>J-&
zlFVS4s~n5L0@a+NV42C2d9Q&5a`=|Af>nr!7=dX|k$YeXEm03fFr!q=kqgY&sbC2<
zZ1Y#;J3?TQD`wl7K#a+KmL?!qO+IRA59YI5=|jb(Cx=)`g4qRD)?j*_l_!|~W#t8?
z-K`<?6l-rV|B-b7m^QV6h&S0df%(U6BEYngZ5WuYwhaQ)7odDiJ6|xr(k>DJ)Y@`?

delta 311
zcmcaqd#RQ;z?+$civa{q7Mf4wRbf5>q)fV)LA-<VVCu07h?>mBs12ewTQJtKfEhbk
zC7Ho8S2-4g1*$nk!7`I4^IiiB<nS$J1*;GdF#^+`BKN=&TB06|U`DB!BNv#lQ^68!
z*ygXwcZ9$qSIo9Eff$qfEKNYJntasK9?WOA(uaymPY$t?1hWgQtikj;D^D=}%gPH(
zyIVu(Dc0U#{v+!EFl}lB5pS|_0`rgCM1W}}+b}R)Z5srpFF^U4cD`VKrClTdw6t<J

diff --git a/src/org/json/simple/parser/ContentHandler.java b/src/org/json/simple/parser/ContentHandler.java
index a898ba0..ae8d065 100644
--- a/src/org/json/simple/parser/ContentHandler.java
+++ b/src/org/json/simple/parser/ContentHandler.java
@@ -6,24 +6,23 @@ import java.io.IOException;
  * A simplified and stoppable SAX-like content handler for stream processing of JSON text. 
  * 
  * @see org.xml.sax.ContentHandler
+ * @see org.json.simple.parser.JSONParser#parse(java.io.Reader, ContentHandler, boolean)
  * 
  * @author FangYidong<fangyidong@yahoo.com.cn>
  */
 public interface ContentHandler {
 	/**
 	 * Receive notification of the beginning of JSON processing.
-	 * 
-	 * User can throw a ParseException with errorType ParseException.INFO_USER_STOP to let the parser stop.
-	 * 
+	 * The parser will invoke this method only once.
+     * 
 	 * @throws ParseException 
-	 * 			JSONParser will stop and throw the same exception to the caller when receiving this exception.
+	 * 			- JSONParser will stop and throw the same exception to the caller when receiving this exception.
 	 */
 	void startJSON() throws ParseException, IOException;
 	
 	/**
 	 * Receive notification of the end of JSON processing.
 	 * 
-	 * @return false if the handler wants to stop parsing after return.
 	 * @throws ParseException
 	 */
 	void endJSON() throws ParseException, IOException;
@@ -33,6 +32,8 @@ public interface ContentHandler {
 	 * 
 	 * @return false if the handler wants to stop parsing after return.
 	 * @throws ParseException
+     *          - JSONParser will stop and throw the same exception to the caller when receiving this exception.
+     * @see #endJSON
 	 */
 	boolean startObject() throws ParseException, IOException;
 	
@@ -41,16 +42,20 @@ public interface ContentHandler {
 	 * 
 	 * @return false if the handler wants to stop parsing after return.
 	 * @throws ParseException
+     * 
+     * @see #startObject
 	 */
 	boolean endObject() throws ParseException, IOException;
 	
 	/**
-	 * Receive notification of the beginning of a JSON object key value pair.
+	 * Receive notification of the beginning of a JSON object entry.
 	 * 
-	 * @param key - Key of a JSON object key value pair. 
+	 * @param key - Key of a JSON object entry. 
 	 * 
 	 * @return false if the handler wants to stop parsing after return.
 	 * @throws ParseException
+     * 
+     * @see #endObjectEntry
 	 */
 	boolean startObjectEntry(String key) throws ParseException, IOException;
 	
@@ -59,6 +64,8 @@ public interface ContentHandler {
 	 * 
 	 * @return false if the handler wants to stop parsing after return.
 	 * @throws ParseException
+     * 
+     * @see #startObjectEntry
 	 */
 	boolean endObjectEntry() throws ParseException, IOException;
 	
@@ -67,6 +74,8 @@ public interface ContentHandler {
 	 * 
 	 * @return false if the handler wants to stop parsing after return.
 	 * @throws ParseException
+     * 
+     * @see #endArray
 	 */
 	boolean startArray() throws ParseException, IOException;
 	
@@ -75,6 +84,8 @@ public interface ContentHandler {
 	 * 
 	 * @return false if the handler wants to stop parsing after return.
 	 * @throws ParseException
+     * 
+     * @see #startArray
 	 */
 	boolean endArray() throws ParseException, IOException;