com.pushtorefresh.storio.sqlite

Class StorIOSQLite

java.lang.Object

com.pushtorefresh.storio.sqlite.StorIOSQLite

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

DefaultStorIOSQLite

public abstract class StorIOSQLite
extends java.lang.Object
implements java.io.Closeable

Powerful but simple abstraction for SQLiteDatabase.

It's an abstract class instead of interface because we want to have ability to add some changes without breaking existing implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StorIOSQLite.Internal Deprecated. please use StorIOSQLite.LowLevel instead, this type will be removed in v2.0, basically we're just giving this API a better name.
static class	StorIOSQLite.LowLevel API for low level operations with StorIOSQLite, we made it separate to make StorIOSQLite API clean and easy to understand.

Constructor Summary

Constructors

Constructor and Description
StorIOSQLite()

Method Summary

Modifier and Type	Method and Description
abstract rx.Scheduler	defaultScheduler() Provides a scheduler on which Observable / Single or Completable will be subscribed.
PreparedDelete.Builder	delete() Prepares "Delete" Operation for StorIOSQLite.
PreparedExecuteSQL.Builder	executeSQL() Prepares "Execute SQL" Operation for StorIOSQLite.
PreparedGet.Builder	get() Prepares "Get" Operation for StorIOSQLite.
abstract StorIOSQLite.Internal	internal() Deprecated. please use lowLevel(), this one will be removed in v2.0, basically, we just renamed it to LowLevel.
abstract StorIOSQLite.LowLevel	lowLevel() An API for low level interaction with DB, it's part of public API, so feel free to use it, but please read documentation carefully!
abstract rx.Observable<Changes>	observeChanges() Allows observe changes in all tables of the db.
rx.Observable<Changes>	observeChangesInTable(java.lang.String table) Allows observer changes of required table.
abstract rx.Observable<Changes>	observeChangesInTables(java.util.Set<java.lang.String> tables) Allows observe changes of required tables.
rx.Observable<Changes>	observeChangesOfTag(java.lang.String tag) Allows observer changes of required tag.
abstract rx.Observable<Changes>	observeChangesOfTags(java.util.Set<java.lang.String> tags) Allows observe changes of required tags.
PreparedPut.Builder	put() Prepares "Put" Operation for StorIOSQLite.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

StorIOSQLite

public StorIOSQLite()

Method Detail

executeSQL

@NonNull
public PreparedExecuteSQL.Builder executeSQL()

Prepares "Execute SQL" Operation for StorIOSQLite. Allows to execute a single SQL statement that is NOT a SELECT/INSERT/UPDATE/DELETE.

Returns:

builder for PreparedExecuteSQL.

get

@NonNull
public PreparedGet.Builder get()

Prepares "Get" Operation for StorIOSQLite. Allows to get information from StorIOSQLite.

Returns:

builder for PreparedGet.

put

@NonNull
public PreparedPut.Builder put()

Prepares "Put" Operation for StorIOSQLite. Allows to insert/update information in StorIOSQLite.

Returns:

builder for PreparedPut.

delete

@NonNull
public PreparedDelete.Builder delete()

Prepares "Delete" Operation for StorIOSQLite. Allows to delete information from StorIOSQLite.

Returns:

builder for PreparedDelete.

observeChanges

@NonNull
public abstract rx.Observable<Changes> observeChanges()

Allows observe changes in all tables of the db.

Notice that StorIOSQLite knows only about changes that happened as a result of Put or Delete Operations executed on this instance of StorIOSQLite.

Emission may happen on any thread that performed Put or Delete operation, so it's recommended to apply Observable.observeOn(rx.Scheduler) if you need to receive events on a special thread.

Notice, that returned Observable is "Hot Observable", it never ends, which means, that you should manually unsubscribe from it to prevent memory leak. Also, it can cause BackPressure problems.

Returns:

Observable of Changes subscribed to changes of all tables.

observeChangesInTables

@NonNull
public abstract rx.Observable<Changes> observeChangesInTables(@NonNull
                                                                       java.util.Set<java.lang.String> tables)

Allows observe changes of required tables.

Notice that StorIOSQLite knows only about changes that happened as a result of Put or Delete Operations executed on this instance of StorIOSQLite.

Emission may happen on any thread that performed Put or Delete operation, so it's recommended to apply Observable.observeOn(rx.Scheduler) if you need to receive events on a special thread.

Notice, that returned Observable is "Hot Observable", it never ends, which means, that you should manually unsubscribe from it to prevent memory leak. Also, it can cause BackPressure problems.

Parameters:

tables - set of table names that should be monitored.

Returns:

Observable of Changes subscribed to changes of required tables.

observeChangesInTable

@NonNull
public rx.Observable<Changes> observeChangesInTable(@NonNull
                                                             java.lang.String table)

Allows observer changes of required table.

Notice that StorIOSQLite knows only about changes that happened as a result of Put or Delete Operations executed on this instance of StorIOSQLite.

Emission may happen on any thread that performed Put or Delete operation, so it's recommended to apply Observable.observeOn(rx.Scheduler) if you need to receive events on a special thread.

Notice, that returned Observable is "Hot Observable", it never ends, which means, that you should manually unsubscribe from it to prevent memory leak. Also, it can cause BackPressure problems.

Parameters:

table - table name to monitor.

Returns:

Observable of Changes subscribed to changes of required table.

observeChangesOfTags

@NonNull
public abstract rx.Observable<Changes> observeChangesOfTags(@NonNull
                                                                     java.util.Set<java.lang.String> tags)

Allows observe changes of required tags.

Tags are optional meta information that you can attach to Changes object to have more fine-grained control over observing changes in the database.

Notice that StorIOSQLite knows only about changes that happened as a result of Put or Delete Operations executed on this instance of StorIOSQLite.

Emission may happen on any thread that performed Put or Delete operation, so it's recommended to apply Observable.observeOn(rx.Scheduler) if you need to receive events on a special thread.

Notice, that returned Observable is "Hot Observable", it never ends, which means, that you should manually unsubscribe from it to prevent memory leak. Also, it can cause BackPressure problems.

Parameters:

tags - set of tags that should be monitored.

Returns:

Observable of Changes subscribed to changes of required tags.

observeChangesOfTag

@NonNull
public rx.Observable<Changes> observeChangesOfTag(@NonNull
                                                           java.lang.String tag)

Allows observer changes of required tag.

Tags are optional meta information that you can attach to Changes object to have more fine-grained control over observing changes in the database.

Notice that StorIOSQLite knows only about changes that happened as a result of Put or Delete Operations executed on this instance of StorIOSQLite.

Emission may happen on any thread that performed Put or Delete operation, so it's recommended to apply Observable.observeOn(rx.Scheduler) if you need to receive events on a special thread.

Notice, that returned Observable is "Hot Observable", it never ends, which means, that you should manually unsubscribe from it to prevent memory leak. Also, it can cause BackPressure problems.

Parameters:

tag - tag to monitor.

Returns:

Observable of Changes subscribed to changes of required tag.

defaultScheduler

@Nullable
public abstract rx.Scheduler defaultScheduler()

Provides a scheduler on which Observable / Single or Completable will be subscribed.

Returns:

the scheduler or null if it isn't needed to apply it.

See Also:

com.pushtorefresh.storio.operations.PreparedOperation#asRxObservable(), com.pushtorefresh.storio.operations.PreparedOperation#asRxSingle(), com.pushtorefresh.storio.operations.PreparedWriteOperation#asRxCompletable()

internal

@Deprecated
 @NonNull
public abstract StorIOSQLite.Internal internal()

Deprecated. please use lowLevel(), this one will be removed in v2.0, basically, we just renamed it to LowLevel.

An API for low level interaction with DB, it's part of public API, so feel free to use it, but please read documentation carefully!

Returns:

implementation of low level APIs for StorIOSQLite.

lowLevel

@NonNull
public abstract StorIOSQLite.LowLevel lowLevel()

An API for low level interaction with DB, it's part of public API, so feel free to use it, but please read documentation carefully!

Returns:

implementation of low level APIs for StorIOSQLite.