ly.count.android.api

Class CountlyStore

java.lang.Object

ly.count.android.api.CountlyStore

public class CountlyStore
extends java.lang.Object

This class provides a persistence layer for the local event & connection queues. The "read" methods in this class are not synchronized, because the underlying data store provides thread-safe reads. The "write" methods in this class are synchronized, because 1) they often read a list of items, modify the list, and then commit it back to the underlying data store, and 2) while the Countly singleton is synchronized to ensure only a single writer at a time from the public API side, the internal implementation has a background thread that submits data to a Countly server, and it writes to this store as well. NOTE: This class is only public to facilitate unit testing, because of this bug in dexmaker: https://code.google.com/p/dexmaker/issues/detail?id=34

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnection(java.lang.String str) Adds a connection to the local store.
void	addEvent(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> segmentation, int timestamp, int count, double sum) Adds a custom event to the local store.
java.lang.String[]	connections() Returns an unsorted array of the current stored connections.
java.lang.String[]	events() Returns an unsorted array of the current stored event JSON strings.
java.util.List<ly.count.android.api.Event>	eventsList() Returns a list of the current stored events, sorted by timestamp from oldest to newest.
java.lang.String	getPreference(java.lang.String key) Retrieves a preference from local store.
boolean	isEmptyConnections() Returns true if no connections are current stored, false otherwise.
void	removeConnection(java.lang.String str) Removes a connection from the local store.
void	removeEvents(java.util.Collection<ly.count.android.api.Event> eventsToRemove) Removes the specified events from the local store.
void	setPreference(java.lang.String key, java.lang.String value) Adds a preference to local store.

Methods inherited from class java.lang.Object

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

Method Detail

connections

public java.lang.String[] connections()

Returns an unsorted array of the current stored connections.

events

public java.lang.String[] events()

Returns an unsorted array of the current stored event JSON strings.

eventsList

public java.util.List<ly.count.android.api.Event> eventsList()

Returns a list of the current stored events, sorted by timestamp from oldest to newest.

isEmptyConnections

public boolean isEmptyConnections()

Returns true if no connections are current stored, false otherwise.

addConnection

public void addConnection(java.lang.String str)

Adds a connection to the local store.

Parameters:

str - the connection to be added, ignored if null or empty

removeConnection

public void removeConnection(java.lang.String str)

Removes a connection from the local store.

Parameters:

str - the connection to be removed, ignored if null or empty, or if a matching connection cannot be found

addEvent

public void addEvent(java.lang.String key,
            java.util.Map<java.lang.String,java.lang.String> segmentation,
            int timestamp,
            int count,
            double sum)

Adds a custom event to the local store.

Parameters:

key - name of the custom event, required, must not be the empty string

segmentation - segmentation values for the custom event, may be null

timestamp - timestamp (seconds since 1970) in GMT when the event occurred

count - count associated with the custom event, should be more than zero

sum - sum associated with the custom event, if not used, pass zero. NaN and infinity values will be quietly ignored.

removeEvents

public void removeEvents(java.util.Collection<ly.count.android.api.Event> eventsToRemove)

Removes the specified events from the local store. Does nothing if the event collection is null or empty.

Parameters:

eventsToRemove - collection containing the events to remove from the local store

getPreference

public java.lang.String getPreference(java.lang.String key)

Retrieves a preference from local store.

Parameters:

key - the preference key

setPreference

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

Adds a preference to local store.

Parameters:

key - the preference key

value - the preference value, supply null value to remove preference