Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.richfaces.json
Class JSONStringer

    java.lang.Object
      org.richfaces.json.JSONWriter
          org.richfaces.json.JSONStringer

    public class JSONStringer

extends JSONWriter

JSONStringer provides a quick and convenient way of producing JSON text. The texts produced strictly conform to JSON syntax rules. No whitespace is added, so the results are ready for transmission or storage. Each instance of JSONStringer can produce one JSON text.

A JSONStringer instance provides a `value` method for appending values to the text, and a `key` method for adding keys before values in objects. There are `array` and `endArray` methods that make and bound array values, and `object` and `endObject` methods which make and bound object values. All of these methods return the JSONWriter instance, permitting cascade style. For example,

     myString = new JSONStringer()
         .object()
             .key("JSON")
             .value("Hello, World!")
         .endObject()
         .toString();

which produces the string

     {"JSON":"Hello, World!"}

The first method called must be `array` or `object`. There are no methods for adding commas or colons. JSONStringer adds them for you. Objects and arrays can be nested up to 20 levels deep.

This can sometimes be easier than using a JSONObject to build a string.

Version:
  2
Author:
  JSON.org

Field Summary

Fields inherited from class org.richfaces.json.JSONWriter
`mode, writer`

Constructor Summary
`JSONStringer()` Make a fresh JSONStringer.

Method Summary
`java.lang.String` | `toString()` Return the JSON text.

Methods inherited from class org.richfaces.json.JSONWriter
`array, endArray, endObject, key, object, value, value, value, value`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### JSONStringer

    public JSONStringer()

  Make a fresh JSONStringer. It can be used to build one JSON text.

Method Detail

### toString

    public java.lang.String toString()

  Return the JSON text. This method is used to obtain the product of the JSONStringer instance. It will return `null` if there was a problem in the construction of the JSON text (such as the calls to `array` were not properly balanced with calls to `endArray`).

  Overrides:
    `toString` in class `java.lang.Object`
  Returns:
    The JSON text.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2010 JBoss, a division of Red Hat, Inc.. All Rights Reserved.