com.pushtorefresh.storio.sqlite.operations.put

Class PutResult

java.lang.Object

com.pushtorefresh.storio.sqlite.operations.put.PutResult

public final class PutResult
extends java.lang.Object

Immutable container for result of Put Operation.

Instances of this class are immutable.

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	affectedTables() Gets names of affected tables.
java.util.Set<java.lang.String>	affectedTags() Gets notification tags which were affected.
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.Long	insertedId() Gets id of inserted row.
static PutResult	newInsertResult(long insertedId, java.util.Set<java.lang.String> affectedTables, java.util.Collection<java.lang.String> affectedTags) Creates PutResult of insert.
static PutResult	newInsertResult(long insertedId, java.util.Set<java.lang.String> affectedTables, java.lang.String... affectedTags) Creates PutResult of insert.
static PutResult	newInsertResult(long insertedId, java.lang.String affectedTable, java.util.Collection<java.lang.String> affectedTags) Creates PutResult of insert.
static PutResult	newInsertResult(long insertedId, java.lang.String affectedTable, java.lang.String... affectedTags) Creates PutResult of insert.
static PutResult	newUpdateResult(int numberOfRowsUpdated, java.util.Set<java.lang.String> affectedTables, java.util.Collection<java.lang.String> affectedTags) Creates PutResult of update.
static PutResult	newUpdateResult(int numberOfRowsUpdated, java.util.Set<java.lang.String> affectedTables, java.lang.String... affectedTags) Creates PutResult of update.
static PutResult	newUpdateResult(int numberOfRowsUpdated, java.lang.String affectedTable, java.util.Collection<java.lang.String> affectedTags) Creates PutResult of update.
static PutResult	newUpdateResult(int numberOfRowsUpdated, java.lang.String affectedTable, java.lang.String... affectedTags) Creates PutResult of update.
java.lang.Integer	numberOfRowsUpdated() Gets number of rows updated.
java.lang.String	toString()
boolean	wasInserted() Checks whether result of Put Operation was "insert".
boolean	wasNotInserted() Checks whether result of Put Operation was NOT "insert".
boolean	wasNotUpdated() Checks whether result of Put Operation was NOT "update".
boolean	wasUpdated() Checks whether result of Put Operation was "update".

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newInsertResult

@NonNull
public static PutResult newInsertResult(long insertedId,
                                                 @NonNull
                                                 java.util.Set<java.lang.String> affectedTables,
                                                 @Nullable
                                                 java.util.Collection<java.lang.String> affectedTags)

Creates PutResult of insert.

Parameters:

insertedId - id of new row.

affectedTables - tables that were affected.

affectedTags - notification tags that were affected.

Returns:

new PutResult instance.

newInsertResult

@NonNull
public static PutResult newInsertResult(long insertedId,
                                                 @NonNull
                                                 java.util.Set<java.lang.String> affectedTables,
                                                 @Nullable
                                                 java.lang.String... affectedTags)

Creates PutResult of insert.

Parameters:

insertedId - id of new row.

affectedTables - tables that were affected.

affectedTags - notification tags that were affected.

Returns:

new PutResult instance.

newInsertResult

@NonNull
public static PutResult newInsertResult(long insertedId,
                                                 @NonNull
                                                 java.lang.String affectedTable,
                                                 @Nullable
                                                 java.util.Collection<java.lang.String> affectedTags)

Creates PutResult of insert.

Parameters:

insertedId - id of new row.

affectedTable - table that was affected.

affectedTags - notification tags that were affected.

Returns:

new PutResult instance.

newInsertResult

@NonNull
public static PutResult newInsertResult(long insertedId,
                                                 @NonNull
                                                 java.lang.String affectedTable,
                                                 @Nullable
                                                 java.lang.String... affectedTags)

Creates PutResult of insert.

Parameters:

insertedId - id of new row.

affectedTable - table that was affected.

affectedTags - notification tags that were affected.

Returns:

new PutResult instance.

newUpdateResult

@NonNull
public static PutResult newUpdateResult(int numberOfRowsUpdated,
                                                 @NonNull
                                                 java.util.Set<java.lang.String> affectedTables,
                                                 @Nullable
                                                 java.util.Collection<java.lang.String> affectedTags)

Creates PutResult of update.

Parameters:

numberOfRowsUpdated - number of rows that were updated, must be >= 0.

affectedTables - tables that were affected.

affectedTags - notification tags that were affected.

Returns:

new PutResult instance.

newUpdateResult

@NonNull
public static PutResult newUpdateResult(int numberOfRowsUpdated,
                                                 @NonNull
                                                 java.util.Set<java.lang.String> affectedTables,
                                                 @Nullable
                                                 java.lang.String... affectedTags)

Creates PutResult of update.

Parameters:

numberOfRowsUpdated - number of rows that were updated, must be >= 0.

affectedTables - tables that were affected.

affectedTags - notification tags that were affected.

Returns:

new PutResult instance.

newUpdateResult

@NonNull
public static PutResult newUpdateResult(int numberOfRowsUpdated,
                                                 @NonNull
                                                 java.lang.String affectedTable,
                                                 @Nullable
                                                 java.util.Collection<java.lang.String> affectedTags)

Creates PutResult of update.

Parameters:

numberOfRowsUpdated - number of rows that were updated, must be >= 0.

affectedTable - table that was affected.

affectedTags - notification tags that were affected.

Returns:

new PutResult instance.

newUpdateResult

@NonNull
public static PutResult newUpdateResult(int numberOfRowsUpdated,
                                                 @NonNull
                                                 java.lang.String affectedTable,
                                                 @Nullable
                                                 java.lang.String... affectedTags)

Creates PutResult of update.

Parameters:

numberOfRowsUpdated - number of rows that were updated, must be >= 0.

affectedTable - table that was affected.

affectedTags - notification tags that were affected.

Returns:

new PutResult instance.

wasInserted

public boolean wasInserted()

Checks whether result of Put Operation was "insert".

Returns:

true if something was inserted into StorIOSQLite, false otherwise.

wasNotInserted

public boolean wasNotInserted()

Checks whether result of Put Operation was NOT "insert".

Returns:

true if nothing was inserted into StorIOSQLite, false if something was inserted.

wasUpdated

public boolean wasUpdated()

Checks whether result of Put Operation was "update".

Returns:

true if something was updated in StorIOSQLite, false if it was "insert" or 0 rows in database were updated (for example: your custom PutResolver may check that there is already stored row with same columns, so no insert will be done, and no actual update should be performed). But also, keep in mind, that DefaultPutResolver will return same value that will return SQLiteDatabase, which will return 1 even if all columns were same.

wasNotUpdated

public boolean wasNotUpdated()

Checks whether result of Put Operation was NOT "update".

Returns:

true if nothing was updated in StorIOSQLite, false if something was updated.

insertedId

@Nullable
public java.lang.Long insertedId()

Gets id of inserted row.

Returns:

null if nothing was inserted or id of inserted row.

numberOfRowsUpdated

@Nullable
public java.lang.Integer numberOfRowsUpdated()

Gets number of rows updated.

Returns:

null if nothing was updated or number of updated rows (>= 0).

affectedTables

@NonNull
public java.util.Set<java.lang.String> affectedTables()

Gets names of affected tables.

Returns:

non-null unmodifiable set of affected tables.

affectedTags

@NonNull
public java.util.Set<java.lang.String> affectedTags()

Gets notification tags which were affected.

Returns:

non-null unmodifiable set of affected tags.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object