com.gigya.socialize

Class GSObject

java.lang.Object

com.gigya.socialize.GSObject

All Implemented Interfaces:

java.io.Serializable

public class GSObject
extends java.lang.Object
implements java.io.Serializable

Used for passing parameters, for example when issuing requests or receiving response data.
The object holds [key, value] pairs. The key represents a parameter name (type String) and the value may be one of the following types:

• String
• boolean
• int
• long
• double
• GSObject
• GSArray

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	GSObject()
protected	GSObject(org.json.JSONObject jo) Construct a GSObject from a JSONObject - used internally
	GSObject(java.lang.String json) Construct a GSObject from a JSON string.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all of the entries from this object.
GSObject	clone() Returns a deep copy of the object.
boolean	containsKey(java.lang.String key) Returns true if this object contains a mapping for the specified key.
java.lang.Object	get(java.lang.String key)
java.lang.Object	get(java.lang.String key, java.lang.Object defaultValue)
GSArray	getArray(java.lang.String key) Returns the GSArray value to which the specified key is mapped.
GSArray	getArray(java.lang.String key, GSArray defaultValue) Returns the GSArray value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.
boolean	getBool(java.lang.String key) Returns the boolean value to which the specified key is mapped.
boolean	getBool(java.lang.String key, boolean defaultValue) Returns the boolean value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.
double	getDouble(java.lang.String key) Returns the double value to which the specified key is mapped.
double	getDouble(java.lang.String key, double defaultValue) Returns the double value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.
int	getInt(java.lang.String key) Returns the int value to which the specified key is mapped.
int	getInt(java.lang.String key, int defaultValue) Returns the int value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.
java.lang.String[]	getKeys() Returns a String array containing the keys in this object.
long	getLong(java.lang.String key) Returns the long value to which the specified key is mapped.
long	getLong(java.lang.String key, long defaultValue) Returns the long value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.
protected java.util.TreeMap<java.lang.String,java.lang.Object>	getMap()
GSObject	getObject(java.lang.String key) Returns the GSObject value to which the specified key is mapped.
GSObject	getObject(java.lang.String key, GSObject defaultValue) Returns the GSobject value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.
java.lang.String	getString(java.lang.String key) Returns the String value to which the specified key is mapped.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Returns the String value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.
void	parseQueryString(java.lang.String qs) Parses parameters from a query string into this object.
void	parseURL(java.lang.String url) Parses parameters from a URL string into this object
void	put(java.lang.String key, boolean value) Associates the specified value with the specified key in this object.
void	put(java.lang.String key, double value) Associates the specified value with the specified key in this object.
void	put(java.lang.String key, GSArray value) Associates the specified value with the specified key in this object.
void	put(java.lang.String key, GSObject value) Associates the specified value with the specified key in this object.
void	put(java.lang.String key, int value) Associates the specified value with the specified key in this object.
void	put(java.lang.String key, long value) Associates the specified value with the specified key in this object.
void	put(java.lang.String key, java.lang.Object value)
void	put(java.lang.String key, java.lang.String value) Associates the specified value with the specified key in this object.
void	remove(java.lang.String key) Removes the key (and its corresponding value) from this object.
protected org.json.JSONObject	toJsonObject()
java.lang.String	toJsonString() Returns the object's content as a JSON string.
java.lang.String	toString() Returns the object's content as a JSON string.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GSObject

public GSObject()

GSObject

public GSObject(java.lang.String json)
         throws java.lang.Exception

Construct a GSObject from a JSON string. Throws an Exception if unable to parse the JSON string.

Parameters:

json - the JSON formatted string

Throws:

java.lang.Exception - if unable to parse the JSON string

GSObject

protected GSObject(org.json.JSONObject jo)
            throws java.lang.Exception

Construct a GSObject from a JSONObject - used internally

Parameters:

jo - the JSON object to parse

Throws:

java.lang.Exception - if unable to parse JSON

Method Detail

put

public void put(java.lang.String key,
                java.lang.String value)

Associates the specified value with the specified key in this object. If the object previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - a string value to be associated with the specified key

put

public void put(java.lang.String key,
                int value)

Associates the specified value with the specified key in this object. If the object previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - a int value to be associated with the specified key

put

public void put(java.lang.String key,
                long value)

Associates the specified value with the specified key in this object. If the object previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - a long value to be associated with the specified key

put

public void put(java.lang.String key,
                double value)

Associates the specified value with the specified key in this object. If the object previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - a double value to be associated with the specified key

put

public void put(java.lang.String key,
                boolean value)

Associates the specified value with the specified key in this object. If the object previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - a boolean value to be associated with the specified key

put

public void put(java.lang.String key,
                GSObject value)

Associates the specified value with the specified key in this object. If the object previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - a GSObject value to be associated with the specified key

put

public void put(java.lang.String key,
                GSArray value)

Associates the specified value with the specified key in this object. If the object previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - a GSArray value to be associated with the specified key

put

public void put(java.lang.String key,
                java.lang.Object value)

getBool

public boolean getBool(java.lang.String key,
                       boolean defaultValue)

Returns the boolean value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the boolean value to be returned if this object doesn't contain the specified key.

Returns:

the boolean value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

getBool

public boolean getBool(java.lang.String key)
                throws GSKeyNotFoundException,
                       java.lang.NullPointerException,
                       java.io.InvalidClassException

Returns the boolean value to which the specified key is mapped.

Parameters:

key - the key whose associated value is to be returned

Returns:

the boolean value to which the specified key is mapped.

Throws:

GSKeyNotFoundException - if this object contains no mapping for the specified

java.lang.NullPointerException

java.io.InvalidClassException

getInt

public int getInt(java.lang.String key,
                  int defaultValue)

Returns the int value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the int value to be returned if this object doesn't contain the specified key.

Returns:

the int value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

getInt

public int getInt(java.lang.String key)
           throws GSKeyNotFoundException,
                  java.lang.NullPointerException,
                  java.io.InvalidClassException

Returns the int value to which the specified key is mapped.

Parameters:

key - the key whose associated value is to be returned

Returns:

the int value to which the specified key is mapped.

Throws:

GSKeyNotFoundException - if this object contains no mapping for the specified

java.lang.NullPointerException

java.io.InvalidClassException

getLong

public long getLong(java.lang.String key,
                    long defaultValue)

Returns the long value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the long value to be returned if this object doesn't contain the specified key.

Returns:

the long value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

getLong

public long getLong(java.lang.String key)
             throws GSKeyNotFoundException,
                    java.lang.NullPointerException,
                    java.io.InvalidClassException

Returns the long value to which the specified key is mapped.

Parameters:

key - the key whose associated value is to be returned

Returns:

the long value to which the specified key is mapped.

Throws:

GSKeyNotFoundException - if this object contains no mapping for the specified

java.lang.NullPointerException

java.io.InvalidClassException

getDouble

public double getDouble(java.lang.String key,
                        double defaultValue)

Returns the double value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the long value to be returned if this object doesn't contain the specified key.

Returns:

the double value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

getDouble

public double getDouble(java.lang.String key)
                 throws GSKeyNotFoundException,
                        java.lang.NullPointerException,
                        java.io.InvalidClassException

Returns the double value to which the specified key is mapped.

Parameters:

key - the key whose associated value is to be returned

Returns:

the double value to which the specified key is mapped.

Throws:

GSKeyNotFoundException - if this object contains no mapping for the specified

java.lang.NullPointerException

java.io.InvalidClassException

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)

Returns the String value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the String value to be returned if this object doesn't contain the specified key.

Returns:

the String value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

getString

public java.lang.String getString(java.lang.String key)
                           throws GSKeyNotFoundException

Returns the String value to which the specified key is mapped.

Parameters:

key - the key whose associated value is to be returned

Returns:

the String value to which the specified key is mapped.

Throws:

GSKeyNotFoundException - if this object contains no mapping for the specified

getObject

public GSObject getObject(java.lang.String key,
                          GSObject defaultValue)

Returns the GSobject value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the GSObject value to be returned if this object doesn't contain the specified key.

Returns:

the GSObject value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

getObject

public GSObject getObject(java.lang.String key)
                   throws GSKeyNotFoundException

Returns the GSObject value to which the specified key is mapped.

Parameters:

key - the key whose associated value is to be returned

Returns:

the GSObject value to which the specified key is mapped.

Throws:

GSKeyNotFoundException - if this object contains no mapping for the specified

getArray

public GSArray getArray(java.lang.String key,
                        GSArray defaultValue)

Returns the GSArray value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the GSArrayvalue to be returned if this object doesn't contain the specified key.

Returns:

the GSArray value to which the specified key is mapped, or the defaultValue if this object contains no mapping for the key.

getArray

public GSArray getArray(java.lang.String key)
                 throws GSKeyNotFoundException

Returns the GSArray value to which the specified key is mapped.

Parameters:

key - the key whose associated value is to be returned

Returns:

the GSArray value to which the specified key is mapped.

Throws:

GSKeyNotFoundException - if this object contains no mapping for the specified key

get

public java.lang.Object get(java.lang.String key,
                            java.lang.Object defaultValue)

get

public java.lang.Object get(java.lang.String key)
                     throws GSKeyNotFoundException

Throws:

GSKeyNotFoundException

parseURL

public void parseURL(java.lang.String url)

Parses parameters from a URL string into this object

Parameters:

url - the URL string to parse

parseQueryString

public void parseQueryString(java.lang.String qs)

Parses parameters from a query string into this object.

Parameters:

qs - the query string to parse

containsKey

public boolean containsKey(java.lang.String key)

Returns true if this object contains a mapping for the specified key.

Parameters:

key - key whose presence in this map is to be tested

Returns:

true if this map contains a mapping for the specified key

remove

public void remove(java.lang.String key)

Removes the key (and its corresponding value) from this object. This method does nothing if the key is not in this object.

Parameters:

key - the key that needs to be removed.

clear

public void clear()

Removes all of the entries from this object. The object will be empty after this call returns.

getKeys

public java.lang.String[] getKeys()

Returns a String array containing the keys in this object.

Returns:

a String[] of the keys in this object.

toString

public java.lang.String toString()

Returns the object's content as a JSON string.

Overrides:

toString in class java.lang.Object

Returns:

the object's content as a JSON string.

toJsonString

public java.lang.String toJsonString()

Returns the object's content as a JSON string.

Returns:

the object's content as a JSON string.

clone

public GSObject clone()

Returns a deep copy of the object.

Overrides:

clone in class java.lang.Object

Returns:

a deep copy of the object.

getMap

protected java.util.TreeMap<java.lang.String,java.lang.Object> getMap()

toJsonObject

protected org.json.JSONObject toJsonObject()
                                    throws org.json.JSONException

Throws:

org.json.JSONException