org.restlet.ext.json
Class JsonRepresentation

java.lang.Object
  org.restlet.representation.Variant
      org.restlet.representation.RepresentationInfo
          org.restlet.representation.Representation
              org.restlet.representation.CharacterRepresentation
                  org.restlet.representation.WriterRepresentation
                      org.restlet.ext.json.JsonRepresentation

public class JsonRepresentation
extends WriterRepresentation

Representation based on a JSON document. JSON stands for JavaScript Object Notation and is a lightweight data-interchange format.

Author:

Jerome Louvel

See Also:

JSON home

Field Summary

Fields inherited from class org.restlet.representation.Representation

UNKNOWN_SIZE

Constructor Summary

JsonRepresentation(JSONArray jsonArray)
Constructor from a JSON array.

JsonRepresentation(JSONObject jsonObject)
Constructor from a JSON object.

JsonRepresentation(JSONStringer jsonStringer)
Constructor from a JSON stringer.

JsonRepresentation(JSONTokener jsonTokener)
Constructor from a JSON tokener.

JsonRepresentation(Map<Object,Object> map)
Constructor from a map object.

JsonRepresentation(Object bean)
Constructor from a bean using reflection to generate JSON names.

JsonRepresentation(Representation jsonRepresentation)
Constructor.

JsonRepresentation(String jsonString)
Constructor from a JSON string.

Method Summary

int	getIndentingSize() Returns the number of spaces to use for indentation.
int	getIndentSize() Deprecated. Use getIndentingSize() instead.
JSONArray	getJsonArray() Gets the wrapped JSON array or converts the wrapped representation if needed.
JSONObject	getJsonObject() Gets the wrapped JSON object or converts the wrapped representation if needed.
JSONTokener	getJsonTokener() Gets the wrapped JSON tokener or converts the wrapped representation if needed.
long	getSize()
boolean	isIndent() Deprecated. Use isIndenting() instead.
boolean	isIndenting() Indicates if JSON objects and arrays should be indented.
void	setIndent(boolean indenting) Deprecated. Use setIndenting(boolean) instead.
void	setIndenting(boolean indenting) Indicates if JSON objects and arrays should be indented.
void	setIndentingSize(int indentFactor) Sets the number of spaces to use for indentation.
void	setIndentSize(int indentFactor) Deprecated. Use setIndentingSize(int) instead
JSONArray	toJsonArray() Deprecated. Use getJsonArray() instead.
JSONObject	toJsonObject() Deprecated. Use getJsonObject() instead.
JSONTokener	toJsonTokener() Deprecated. Use getJsonTokener() instead.
void	write(Writer writer)

Methods inherited from class org.restlet.representation.WriterRepresentation

getReader, release, write

Methods inherited from class org.restlet.representation.CharacterRepresentation

getChannel, getStream, write

Methods inherited from class org.restlet.representation.Representation

checkDigest, checkDigest, computeDigest, createEmpty, exhaust, getAvailableSize, getDigest, getDisposition, getDownloadName, getExpirationDate, getRange, getText, isAvailable, isDownloadable, isTransient, setAvailable, setDigest, setDisposition, setDownloadable, setDownloadName, setExpirationDate, setRange, setSize, setTransient

Methods inherited from class org.restlet.representation.RepresentationInfo

getModificationDate, getTag, setModificationDate, setTag

Methods inherited from class org.restlet.representation.Variant

createClientInfo, equals, getCharacterSet, getEncodings, getIdentifier, getLanguages, getLocationRef, getMediaType, includes, isCompatible, setCharacterSet, setEncodings, setIdentifier, setIdentifier, setLanguages, setLocationRef, setLocationRef, setMediaType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JsonRepresentation

public JsonRepresentation(JSONArray jsonArray)

Constructor from a JSON array.

Parameters:

jsonArray - The JSON array.

JsonRepresentation

public JsonRepresentation(JSONObject jsonObject)

Constructor from a JSON object.

Parameters:

jsonObject - The JSON object.

JsonRepresentation

public JsonRepresentation(JSONStringer jsonStringer)

Constructor from a JSON stringer.

Parameters:

jsonStringer - The JSON stringer.

JsonRepresentation

public JsonRepresentation(JSONTokener jsonTokener)

Constructor from a JSON tokener.

Parameters:

jsonTokener - The JSON tokener.

JsonRepresentation

public JsonRepresentation(Map<Object,Object> map)

Constructor from a map object.

Parameters:

map - The map to convert to JSON.

See Also:

JSONObject.JSONObject(Map)

JsonRepresentation

public JsonRepresentation(Object bean)

Constructor from a bean using reflection to generate JSON names.

Parameters:

bean - The bean to convert to JSON.

See Also:

JSONObject.JSONObject(Object)

JsonRepresentation

public JsonRepresentation(Representation jsonRepresentation)
                   throws IOException

Constructor.

Parameters:

jsonRepresentation - A source JSON representation to parse.

Throws:

IOException

JsonRepresentation

public JsonRepresentation(String jsonString)

Constructor from a JSON string.

Parameters:

jsonString - The JSON string.

Method Detail

getIndentingSize

public int getIndentingSize()

Returns the number of spaces to use for indentation.

Returns:

The number of spaces to use for indentation.

getIndentSize

@Deprecated
public int getIndentSize()

Deprecated. Use getIndentingSize() instead.

Returns the number of spaces to use for indentation.

Returns:

The number of spaces to use for indentation.

getJsonArray

public JSONArray getJsonArray()
                       throws JSONException

Gets the wrapped JSON array or converts the wrapped representation if needed.

Returns:

The converted JSON array.

Throws:

JSONException

getJsonObject

public JSONObject getJsonObject()
                         throws JSONException

Gets the wrapped JSON object or converts the wrapped representation if needed.

Returns:

The converted JSON object.

Throws:

JSONException

getJsonTokener

public JSONTokener getJsonTokener()
                           throws JSONException

Gets the wrapped JSON tokener or converts the wrapped representation if needed.

Returns:

The converted JSON tokener.

Throws:

JSONException

getSize

public long getSize()

Overrides:

getSize in class Representation

isIndent

@Deprecated
public boolean isIndent()

Deprecated. Use isIndenting() instead.

Indicates if JSON objects and arrays should be indented.

Returns:

True if JSON objects and arrays should be indented.

isIndenting

public boolean isIndenting()

Indicates if JSON objects and arrays should be indented.

Returns:

True if JSON objects and arrays should be indented.

setIndent

@Deprecated
public void setIndent(boolean indenting)

Deprecated. Use setIndenting(boolean) instead.

Indicates if JSON objects and arrays should be indented.

Parameters:

indenting - True if JSON objects and arrays should be indented.

setIndenting

public void setIndenting(boolean indenting)

Indicates if JSON objects and arrays should be indented.

Parameters:

indenting - True if JSON objects and arrays should be indented.

setIndentingSize

public void setIndentingSize(int indentFactor)

Sets the number of spaces to use for indentation.

Parameters:

indentFactor - The number of spaces to use for indentation.

setIndentSize

@Deprecated
public void setIndentSize(int indentFactor)

Deprecated. Use setIndentingSize(int) instead

Sets the number of spaces to use for indentation.

Parameters:

indentFactor - The number of spaces to use for indentation.

toJsonArray

@Deprecated
public JSONArray toJsonArray()
                      throws JSONException

Deprecated. Use getJsonArray() instead.

Converts the representation to a JSON array. This method will trigger the serialization of any wrapped JSON array.

Returns:

The converted JSON array.

Throws:

JSONException

toJsonObject

@Deprecated
public JSONObject toJsonObject()
                        throws JSONException

Deprecated. Use getJsonObject() instead.

Converts the representation to a JSON object. This method will trigger the serialization of any wrapped JSON object.

Returns:

The converted JSON object.

Throws:

JSONException

toJsonTokener

@Deprecated
public JSONTokener toJsonTokener()
                          throws JSONException

Deprecated. Use getJsonTokener() instead.

Converts the representation to a JSON tokener. This method will trigger the serialization of any wrapped JSON tokener.

Returns:

The converted JSON tokener.

Throws:

JSONException

write

public void write(Writer writer)
           throws IOException

Specified by:

write in class Representation

Throws:

IOException