org.piwik.java.tracking

Class PiwikJsonObject

java.lang.Object

org.piwik.java.tracking.PiwikJsonObject

Deprecated.

@Deprecated
public class PiwikJsonObject
extends Object

Object representing the custom variable array required by some Piwik query parameters. An array is represented by an object that has the index of the entry as the key (1 indexed) and a 2 entry array representing a custom key and custom value as the value.

Author:

brettcsorba

Constructor Summary

Constructors

Constructor and Description
PiwikJsonObject() Deprecated.

Method Summary

Modifier and Type	Method and Description
String	get(String key) Deprecated. Gets the custom value stored at this custom key.
boolean	isEmpty() Deprecated. Returns true if this object contains no custom key-value pairs.
String	put(String key, String value) Deprecated. Puts a custom value at this custom key.
String	remove(String key) Deprecated. Removes the custom value stored at this custom key.
int	size() Deprecated. Returns the number of custom key-value pairs.
String	toString() Deprecated. Produces the JSON string representing this object. For example, if the following values were put into the object ("key1", "value1") and ("key2", "value2") {"1": ["key1", "value1"], "2": ["key2": "value2"]} would be produced.

Methods inherited from class java.lang.Object

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

Constructor Detail

PiwikJsonObject

public PiwikJsonObject()

Deprecated.

Method Detail

get

public String get(String key)

Deprecated.

Gets the custom value stored at this custom key.

Parameters:

key - key used to lookup value

Returns:

value stored at specified key, null if not present

isEmpty

public boolean isEmpty()

Deprecated.

Returns true if this object contains no custom key-value pairs.

Returns:

true if this object contains no custom key-value pairs

put

public String put(String key,
                  String value)

Deprecated.

Puts a custom value at this custom key.

Parameters:

key - key to store value at

value - value to store at specified key

Returns:

previous value stored at key if present, null otherwise

remove

public String remove(String key)

Deprecated.

Removes the custom value stored at this custom key.

Parameters:

key - key used to lookup value to remove

Returns:

the value that was removed, null if no value was there to remove

size

public int size()

Deprecated.

Returns the number of custom key-value pairs.

Returns:

the number of custom key-value pairs

toString

public String toString()

Deprecated.

Produces the JSON string representing this object.

For example, if the following values were put into the object

("key1", "value1") and ("key2", "value2")

{"1": ["key1", "value1"], "2": ["key2": "value2"]}

would be produced. The produced JSON will be ordered according to the order the values were put in. Removing an object will cause the values to backfill accordingly.

For example, if the following values were put into the object

("key1", "value1"), ("key2", "value2"), and ("key3", "value3")

and ("key2", "value2") was then removed, then

{"1": ["key1", "value1"], "2": ["key3": "value3"]}

would be produced.

Overrides:

toString in class Object

Returns:

the JSON string representation of this object