464727 - Update Javadoc for Java 8 DocLint

This commit is contained in:
Joakim Erdfelt 2015-04-22 12:36:33 -07:00
parent 4f3b4c5d3b
commit 72c0fb9a0d
2 changed files with 21 additions and 21 deletions

View File

@ -44,25 +44,25 @@ import org.eclipse.jetty.util.log.Logger;
* notation. The mapping from JSON to java is:
*
* <pre>
* object ==> Map
* array ==> Object[]
* number ==> Double or Long
* string ==> String
* null ==> null
* bool ==> Boolean
* object --&gt; Map
* array --&gt; Object[]
* number --&gt; Double or Long
* string --&gt; String
* null --&gt; null
* bool --&gt; Boolean
* </pre>
* The java to JSON mapping is:
*
* <pre>
* String --> string
* Number --> number
* Map --> object
* List --> array
* Array --> array
* null --> null
* Boolean--> boolean
* Object --> string (dubious!)
* String --&gt; string
* Number --&gt; number
* Map --&gt; object
* List --&gt; array
* Array --&gt; array
* null --&gt; null
* Boolean--&gt; boolean
* Object --&gt; string (dubious!)
* </pre>
*
* The interface {@link JSON.Convertible} may be implemented by classes that
@ -188,6 +188,7 @@ public class JSON
* @param in
* Reader containing JSON object or array.
* @return A Map, Object array or primitive array parsed from the JSON.
* @throws IOException if unable to parse
*/
public static Object parse(Reader in) throws IOException
{
@ -200,6 +201,7 @@ public class JSON
* @param stripOuterComment
* If true, an outer comment around the JSON is ignored.
* @return A Map, Object array or primitive array parsed from the JSON.
* @throws IOException if unable to parse
*/
public static Object parse(Reader in, boolean stripOuterComment) throws IOException
{
@ -207,10 +209,11 @@ public class JSON
}
/**
* @deprecated use {@link #parse(Reader)}
* @param in
* Reader containing JSON object or array.
* @return A Map, Object array or primitive array parsed from the JSON.
* @throws IOException if unable to parse
* @deprecated use {@link #parse(Reader)}
*/
@Deprecated
public static Object parse(InputStream in) throws IOException
@ -219,12 +222,13 @@ public class JSON
}
/**
* @deprecated use {@link #parse(Reader, boolean)}
* @param in
* Stream containing JSON object or array.
* @param stripOuterComment
* If true, an outer comment around the JSON is ignored.
* @return A Map, Object array or primitive array parsed from the JSON.
* @throws IOException if unable to parse
* @deprecated use {@link #parse(Reader, boolean)}
*/
@Deprecated
public static Object parse(InputStream in, boolean stripOuterComment) throws IOException

View File

@ -28,12 +28,8 @@ import java.util.Set;
import org.eclipse.jetty.util.ajax.JSON.Output;
/* ------------------------------------------------------------ */
/**
* Convert an Object to JSON using reflection on getters methods.
*
*
*
*/
public class JSONObjectConvertor implements JSON.Convertor
{
@ -52,7 +48,7 @@ public class JSONObjectConvertor implements JSON.Convertor
/* ------------------------------------------------------------ */
/**
* @param fromJSON
* @param fromJSON true to convert from JSON
* @param excluded An array of field names to exclude from the conversion
*/
public JSONObjectConvertor(boolean fromJSON,String[] excluded)