com.pushtorefresh.storio.sqlite.impl

Class DefaultStorIOSQLite

java.lang.Object

com.pushtorefresh.storio.sqlite.StorIOSQLite

com.pushtorefresh.storio.sqlite.impl.DefaultStorIOSQLite

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class DefaultStorIOSQLite
extends StorIOSQLite

Default implementation of StorIOSQLite for SQLiteDatabase.

Thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultStorIOSQLite.Builder Builder for DefaultStorIOSQLite.
static class	DefaultStorIOSQLite.CompleteBuilder Compile-time safe part of builder for DefaultStorIOSQLite.
protected class	DefaultStorIOSQLite.InternalImpl Deprecated.
protected class	DefaultStorIOSQLite.LowLevelImpl API for low level operations with StorIOSQLite, we made it separate to make StorIOSQLite API clean and easy to understand.

Nested classes/interfaces inherited from class com.pushtorefresh.storio.sqlite.StorIOSQLite

StorIOSQLite.Internal, StorIOSQLite.LowLevel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultStorIOSQLite(android.database.sqlite.SQLiteOpenHelper sqLiteOpenHelper, TypeMappingFinder typeMappingFinder, rx.Scheduler defaultScheduler)

Method Summary

Modifier and Type	Method and Description
static DefaultStorIOSQLite.Builder	builder() Creates new builder for DefaultStorIOSQLite.
void	close() Closes underlying SQLiteOpenHelper.
rx.Scheduler	defaultScheduler() Provides a scheduler on which Observable / Single or Completable will be subscribed.
StorIOSQLite.Internal	internal() Deprecated.
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!
rx.Observable<Changes>	observeChanges() Allows observe changes in all tables of the db.
rx.Observable<Changes>	observeChangesInTables(java.util.Set<java.lang.String> tables) Allows observe changes of required tables.
rx.Observable<Changes>	observeChangesOfTags(java.util.Set<java.lang.String> tags) Allows observe changes of required tags.

Methods inherited from class com.pushtorefresh.storio.sqlite.StorIOSQLite

delete, executeSQL, get, observeChangesInTable, observeChangesOfTag, put

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultStorIOSQLite

protected DefaultStorIOSQLite(@NonNull
                              android.database.sqlite.SQLiteOpenHelper sqLiteOpenHelper,
                              @NonNull
                              TypeMappingFinder typeMappingFinder,
                              @Nullable
                              rx.Scheduler defaultScheduler)

Method Detail

observeChanges

@NonNull
public 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.

Specified by:

observeChanges in class StorIOSQLite

Returns:

Observable of Changes subscribed to changes of all tables.

observeChangesInTables

@NonNull
public 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.

Specified by:

observeChangesInTables in class StorIOSQLite

Parameters:

tables - set of table names that should be monitored.

Returns:

Observable of Changes subscribed to changes of required tables.

observeChangesOfTags

@NonNull
public 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.

Specified by:

observeChangesOfTags in class StorIOSQLite

Parameters:

tags - set of tags that should be monitored.

Returns:

Observable of Changes subscribed to changes of required tags.

defaultScheduler

public rx.Scheduler defaultScheduler()

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

Specified by:

defaultScheduler in class StorIOSQLite

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

@NonNull
 @Deprecated
public StorIOSQLite.Internal internal()

Deprecated.

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!

Specified by:

internal in class StorIOSQLite

Returns:

implementation of low level APIs for StorIOSQLite.

lowLevel

@NonNull
public 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!

Specified by:

lowLevel in class StorIOSQLite

Returns:

implementation of low level APIs for StorIOSQLite.

close

public void close()
           throws java.io.IOException

Closes underlying SQLiteOpenHelper.

All calls to this instance of StorIOSQLite after call to this method can produce exceptions and undefined behavior.

Throws:

java.io.IOException

builder

@NonNull
public static DefaultStorIOSQLite.Builder builder()

Creates new builder for DefaultStorIOSQLite.

Returns:

non-null instance of DefaultStorIOSQLite.Builder.