ly.count.sdk.java.internal

Class Storage

java.lang.Object

ly.count.sdk.java.internal.Storage

public class Storage
extends java.lang.Object

Storing and retrieving data from internal storage of SDK. Thread safety is based on single thread of execution - only one thread works with storage at a particular time thanks to Tasks.

Constructor Summary

Constructors

Constructor and Description
Storage()

Method Summary

Modifier and Type	Method and Description
static void	await()
static java.util.List<java.lang.Long>	list(CtxCore ctx, java.lang.String prefix) Retrieves ids of all files stored for a specific prefix (Storable.storagePrefix().
static java.util.List<java.lang.Long>	list(CtxCore ctx, java.lang.String prefix, int slice) Retrieves ids of files stored for a specific prefix (Storable.storagePrefix().
static java.util.concurrent.Future<java.util.List<java.lang.Long>>	listAsync(CtxCore ctx, java.lang.String prefix, int slice) Retrieves ids of files stored for a specific prefix (Storable.storagePrefix().
static java.lang.String	name(Storable storable)
static <T extends Storable> T	pop(CtxCore ctx, T storable) Reinitializes storable with data stored previously in device internal memory and deletes corresponding file.
static <T extends Storable> java.util.concurrent.Future<T>	popAsync(CtxCore ctx, T storable) Reinitializes storable with data stored previously in device internal memory.
static boolean	push(CtxCore ctx, Storable storable) Stores data in device internal memory.
static java.util.concurrent.Future<java.lang.Boolean>	pushAsync(CtxCore ctx, Storable storable) Shorthand for pushAsync(CtxCore, Storable, Tasks.Callback)
static java.util.concurrent.Future<java.lang.Boolean>	pushAsync(CtxCore ctx, Storable storable, Tasks.Callback<java.lang.Boolean> callback) Stores data in device internal memory.
static <T extends Storable> T	read(CtxCore ctx, T storable) Reinitializes storable with data stored previously in device internal memory.
static <T extends Storable> java.util.concurrent.Future<T>	readAsync(CtxCore ctx, T storable) Reinitializes storable with data stored previously in device internal memory.
static <T extends Storable> java.util.concurrent.Future<T>	readAsync(CtxCore ctx, T storable, Tasks.Callback<T> callback) Reinitializes storable with data stored previously in device internal memory.
static <T extends Storable> T	readOne(CtxCore ctx, T storable, boolean asc) Reinitializes first (or last if asc is false) storable with prefix from storable supplied as parameter.
static <T extends Storable> java.util.concurrent.Future<T>	readOneAsync(CtxCore ctx, T storable, boolean asc) Reinitializes first (or last if asc is false) storable with prefix from storable supplied as parameter.
static <T extends Storable> java.lang.Boolean	remove(CtxCore ctx, T storable) Removes storable from storage.
static <T extends Storable> java.util.concurrent.Future<java.lang.Boolean>	removeAsync(CtxCore ctx, T storable, Tasks.Callback<java.lang.Boolean> callback) Removes storable from storage.
static void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

Storage

public Storage()

Method Detail

name

public static java.lang.String name(Storable storable)

push

public static boolean push(CtxCore ctx,
                           Storable storable)

Stores data in device internal memory. When a storable with the same id already exists, replaces it with new data.

Parameters:

ctx - context to run in

storable - Object to store

Returns:

true when storing succeeded, false otherwise

pushAsync

public static java.util.concurrent.Future<java.lang.Boolean> pushAsync(CtxCore ctx,
                                                                       Storable storable,
                                                                       Tasks.Callback<java.lang.Boolean> callback)

Stores data in device internal memory. When a storable with the same id already exists, replaces it with new data. Runs in a storage thread provided by Tasks

Parameters:

ctx - context to run in

storable - Object to store

callback - nullable callback to call when done

Returns:

Future object which resolves as true when storing succeeded, false otherwise

pushAsync

public static java.util.concurrent.Future<java.lang.Boolean> pushAsync(CtxCore ctx,
                                                                       Storable storable)

Shorthand for pushAsync(CtxCore, Storable, Tasks.Callback)

Parameters:

ctx - context to run in

storable - Object to store

Returns:

Future object which resolves as true when storing succeeded, false otherwise

remove

public static <T extends Storable> java.lang.Boolean remove(CtxCore ctx,
                                                            T storable)

Removes storable from storage.

Parameters:

ctx - context to run in

storable - Object to remove

Returns:

true if removed, false otherwise

removeAsync

public static <T extends Storable> java.util.concurrent.Future<java.lang.Boolean> removeAsync(CtxCore ctx,
                                                                                              T storable,
                                                                                              Tasks.Callback<java.lang.Boolean> callback)

Removes storable from storage. Runs in a storage thread provided by Tasks

Parameters:

ctx - context to run in

storable - Object to remove

Returns:

Future object which resolves to true if storable is removed, false otherwise

pop

public static <T extends Storable> T pop(CtxCore ctx,
                                         T storable)

Reinitializes storable with data stored previously in device internal memory and deletes corresponding file.

Parameters:

ctx - context to run in

storable - Object to reinitialize

Returns:

storable object passed as param when restoring succeeded, null otherwise

popAsync

public static <T extends Storable> java.util.concurrent.Future<T> popAsync(CtxCore ctx,
                                                                           T storable)

Reinitializes storable with data stored previously in device internal memory. Runs in a storage thread provided by Tasks

Parameters:

ctx - context to run in

storable - Object to reinitialize

Returns:

Future object which resolves as object passed as param when restoring succeeded, null otherwise

read

public static <T extends Storable> T read(CtxCore ctx,
                                          T storable)

Reinitializes storable with data stored previously in device internal memory.

Parameters:

ctx - context to run in

storable - Object to reinitialize

Returns:

storable object passed as param when reading succeeded, null otherwise

readAsync

public static <T extends Storable> java.util.concurrent.Future<T> readAsync(CtxCore ctx,
                                                                            T storable)

Reinitializes storable with data stored previously in device internal memory. Runs in a storage thread provided by Tasks

Parameters:

ctx - context to run in

storable - Object to reinitialize

Returns:

Future object which resolves as object passed as param when reading succeeded, null otherwise

readAsync

public static <T extends Storable> java.util.concurrent.Future<T> readAsync(CtxCore ctx,
                                                                            T storable,
                                                                            Tasks.Callback<T> callback)

Reinitializes storable with data stored previously in device internal memory. Runs in a storage thread provided by Tasks

Parameters:

ctx - context to run in

storable - Object to reinitialize

callback - Callback to call with read result

Returns:

Future object which resolves as object passed as param when reading succeeded, null otherwise

readOne

public static <T extends Storable> T readOne(CtxCore ctx,
                                             T storable,
                                             boolean asc)

Reinitializes first (or last if asc is false) storable with prefix from storable supplied as parameter.

Parameters:

ctx - context to run in

storable - Object to get prefix from

asc - true if reading first storable, false if reading last one

Returns:

storable object passed as param when reading succeeded, null otherwise

readOneAsync

public static <T extends Storable> java.util.concurrent.Future<T> readOneAsync(CtxCore ctx,
                                                                               T storable,
                                                                               boolean asc)

Reinitializes first (or last if asc is false) storable with prefix from storable supplied as parameter. Runs in a storage thread provided by Tasks

Parameters:

ctx - Ctx to run in

storable - Object to get prefix from

asc - true if reading first storable, false if reading last one

Returns:

Future object which resolves as object passed as param when reading succeeded, null otherwise

list

public static java.util.List<java.lang.Long> list(CtxCore ctx,
                                                  java.lang.String prefix)

Retrieves ids of all files stored for a specific prefix (Storable.storagePrefix(). Runs in a storage thread provided by Tasks, current thread waits for read completion.

Parameters:

prefix - String representing type of storable to list (prefix of file names)

Returns:

List object which resolves as list of storable ids, not null

list

public static java.util.List<java.lang.Long> list(CtxCore ctx,
                                                  java.lang.String prefix,
                                                  int slice)

Retrieves ids of files stored for a specific prefix (Storable.storagePrefix(). Runs in a storage thread provided by Tasks, current thread waits for read completion.

Parameters:

prefix - String representing type of storable to list (prefix of file names)

slice - integer controlling number and slice direction of results returned: 0 to return all records 1..N to return first N records ordered from first to last -1..-N to return last N records ordered from last to first

Returns:

List object which resolves as list of storable ids, not null

listAsync

public static java.util.concurrent.Future<java.util.List<java.lang.Long>> listAsync(CtxCore ctx,
                                                                                    java.lang.String prefix,
                                                                                    int slice)

Retrieves ids of files stored for a specific prefix (Storable.storagePrefix(). Runs in a storage thread provided by Tasks

Parameters:

prefix - String representing type of storable to list (prefix of file names)

slice - integer controlling number and slice direction of results returned: 0 to return all records 1..N to return first N records ordered from first to last -1..-N to return last N records ordered from last to first

Returns:

Future> object which resolves as list of storable ids, not null

await

public static void await()

stop

public static void stop()