Johannes
/
gson-comments
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Minor improvements to TypeAdapter javadocs to promote the use of nullSafe.

This commit is contained in:
Inderjeet Singh 2011-12-06 08:32:19 +00:00
parent 0b734e46e1
commit b19e187bdd
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
gson/src/main/java/com/google/gson/TypeAdapter.java
View File

@ -76,24 +76,28 @@ import com.google.gson.stream.JsonWriter;
* too many values may cause the application to crash.
*
* <p>Type adapters should be prepared to read null from the stream and write it
* to the stream. If your {@code Gson} instance has been configured to {@link
* GsonBuilder#serializeNulls()}, these will be written to the final document.
* Otherwise the value (and the corresponding name when writing to a JSON
* object) will be omitted automatically. In either case your type adapter must
* handle null.
* to the stream. Alternatively, they should use {@link #nullSafe()} method while
* registering the type adapter with Gson. If your {@code Gson} instance
* has been configured to {@link GsonBuilder#serializeNulls()}, these nulls will be
* written to the final document. Otherwise the value (and the corresponding name
* when writing to a JSON object) will be omitted automatically. In either case
* your type adapter must handle null.
*
* <p>To use a custom type adapter with Gson, you must <i>register</i> it with a
* {@link GsonBuilder}: <pre> {@code
*
* GsonBuilder builder = new GsonBuilder();
* builder.registerTypeAdapter(Point.class, new PointAdapter());
* // if PointAdapter didn't check for nulls in its read/write methods, you should instead use
* // builder.registerTypeAdapter(Point.class, new PointAdapter().nullSafe());
* ...
* Gson gson = builder.create();
* }</pre>
*
* <h3>JSON Conversion</h3>
* <p>Retrieve a type adapter from a {@code Gson} instance to deserialize a JSON
* document into a Java object: <pre> {@code
* <p>A type adapter registered with Gson is automatically invoked while serializing
* or deserializing JSON. However, you can also use type adapters directly to serialize
* and deserialize JSON. Here is an example for deserialization: <pre> {@code
*
* String json = "{'origin':'0,0','points':['1,2','3,4']}";
* TypeAdapter<Graph> graphAdapter = gson.getAdapter(Graph.class);