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

Fixed issue 552 by documenting when fromJson returns null.

Browse Source
This commit is contained in:
Inderjeet Singh 2014-03-29 23:28:52 +00:00
parent c53e255105
commit b373c20136
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
gson/src/main/java/com/google/gson/Gson.java
View File

@ -696,7 +696,7 @@ public final class Gson {
* @param <T> the type of the desired object * @param <T> the type of the desired object
* @param json the string from which the object is to be deserialized * @param json the string from which the object is to be deserialized
* @param classOfT the class of T * @param classOfT the class of T
* @return an object of type T from the string * @return an object of type T from the string. Returns {@code null} if {@code json} is {@code null}.
* @throws JsonSyntaxException if json is not a valid representation for an object of type * @throws JsonSyntaxException if json is not a valid representation for an object of type
* classOfT * classOfT
*/ */
@ -719,7 +719,7 @@ public final class Gson {
* <pre> * <pre>
* Type typeOfT = new TypeToken&lt;Collection&lt;Foo&gt;&gt;(){}.getType(); * Type typeOfT = new TypeToken&lt;Collection&lt;Foo&gt;&gt;(){}.getType();
* </pre> * </pre>
* @return an object of type T from the string * @return an object of type T from the string. Returns {@code null} if {@code json} is {@code null}.
* @throws JsonParseException if json is not a valid representation for an object of type typeOfT * @throws JsonParseException if json is not a valid representation for an object of type typeOfT
* @throws JsonSyntaxException if json is not a valid representation for an object of type * @throws JsonSyntaxException if json is not a valid representation for an object of type
*/ */
@ -746,7 +746,7 @@ public final class Gson {
* @param <T> the type of the desired object * @param <T> the type of the desired object
* @param json the reader producing the Json from which the object is to be deserialized. * @param json the reader producing the Json from which the object is to be deserialized.
* @param classOfT the class of T * @param classOfT the class of T
* @return an object of type T from the string * @return an object of type T from the string. Returns {@code null} if {@code json} is at EOF.
* @throws JsonIOException if there was a problem reading from the Reader * @throws JsonIOException if there was a problem reading from the Reader
* @throws JsonSyntaxException if json is not a valid representation for an object of type * @throws JsonSyntaxException if json is not a valid representation for an object of type
* @since 1.2 * @since 1.2
@ -772,7 +772,7 @@ public final class Gson {
* <pre> * <pre>
* Type typeOfT = new TypeToken&lt;Collection&lt;Foo&gt;&gt;(){}.getType(); * Type typeOfT = new TypeToken&lt;Collection&lt;Foo&gt;&gt;(){}.getType();
* </pre> * </pre>
* @return an object of type T from the json * @return an object of type T from the json. Returns {@code null} if {@code json} is at EOF.
* @throws JsonIOException if there was a problem reading from the Reader * @throws JsonIOException if there was a problem reading from the Reader
* @throws JsonSyntaxException if json is not a valid representation for an object of type * @throws JsonSyntaxException if json is not a valid representation for an object of type
* @since 1.2 * @since 1.2
@ -799,7 +799,7 @@ public final class Gson {
/** /**
* Reads the next JSON value from {@code reader} and convert it to an object * Reads the next JSON value from {@code reader} and convert it to an object
* of type {@code typeOfT}. * of type {@code typeOfT}. Returns {@code null}, if the {@code reader} is at EOF.
* Since Type is not parameterized by T, this method is type unsafe and should be used carefully * Since Type is not parameterized by T, this method is type unsafe and should be used carefully
* *
* @throws JsonIOException if there was a problem writing to the Reader * @throws JsonIOException if there was a problem writing to the Reader
@ -848,7 +848,7 @@ public final class Gson {
* @param json the root of the parse tree of {@link JsonElement}s from which the object is to * @param json the root of the parse tree of {@link JsonElement}s from which the object is to
* be deserialized * be deserialized
* @param classOfT The class of T * @param classOfT The class of T
* @return an object of type T from the json * @return an object of type T from the json. Returns {@code null} if {@code json} is {@code null}.
* @throws JsonSyntaxException if json is not a valid representation for an object of type typeOfT * @throws JsonSyntaxException if json is not a valid representation for an object of type typeOfT
* @since 1.3 * @since 1.3
*/ */
@ -871,7 +871,7 @@ public final class Gson {
* <pre> * <pre>
* Type typeOfT = new TypeToken&lt;Collection&lt;Foo&gt;&gt;(){}.getType(); * Type typeOfT = new TypeToken&lt;Collection&lt;Foo&gt;&gt;(){}.getType();
* </pre> * </pre>
* @return an object of type T from the json * @return an object of type T from the json. Returns {@code null} if {@code json} is {@code null}.
* @throws JsonSyntaxException if json is not a valid representation for an object of type typeOfT * @throws JsonSyntaxException if json is not a valid representation for an object of type typeOfT
* @since 1.3 * @since 1.3
*/ */