micro_utils.dokka
0.15.1

# Package-level declarations

## Types

ColumnType
Link copied to clipboard
sealed class ColumnType
CRUDRepo
Link copied to clipboard
interface CRUDRepo<ObjectType, IdType, InputValueType> : ReadCRUDRepo<ObjectType, IdType> , WriteCRUDRepo<ObjectType, IdType, InputValueType>
CursorIterator
Link copied to clipboard
class CursorIterator(c: Cursor) : Iterator<Cursor>
DelegateBasedCRUDRepo
Link copied to clipboard
class DelegateBasedCRUDRepo<ObjectType, IdType, InputValueType>(readDelegate: ReadCRUDRepo<ObjectType, IdType>, writeDelegate: WriteCRUDRepo<ObjectType, IdType, InputValueType>) : CRUDRepo<ObjectType, IdType, InputValueType> , ReadCRUDRepo<ObjectType, IdType> , WriteCRUDRepo<ObjectType, IdType, InputValueType>
DelegateBasedKeyValueRepo
Link copied to clipboard
class DelegateBasedKeyValueRepo<Key, Value>(readDelegate: ReadKeyValueRepo<Key, Value>, writeDelegate: WriteKeyValueRepo<Key, Value>) : KeyValueRepo<Key, Value> , ReadKeyValueRepo<Key, Value> , WriteKeyValueRepo<Key, Value>
DelegateBasedKeyValuesRepo
Link copied to clipboard
class DelegateBasedKeyValuesRepo<Key, Value>(readDelegate: ReadKeyValuesRepo<Key, Value>, writeDelegate: WriteKeyValuesRepo<Key, Value>) : KeyValuesRepo<Key, Value> , ReadKeyValuesRepo<Key, Value> , WriteKeyValuesRepo<Key, Value>
FileKeyValueRepo
Link copied to clipboard
class FileKeyValueRepo(folder: File, filesChangedProcessingScope: CoroutineScope? = null) : KeyValueRepo<String, File> , WriteKeyValueRepo<String, File> , ReadKeyValueRepo<String, File>
FileReadKeyValueRepo
Link copied to clipboard
class FileReadKeyValueRepo(folder: File) : ReadKeyValueRepo<String, File>
FileWriteKeyValueRepo
Link copied to clipboard
class FileWriteKeyValueRepo(folder: File, filesChangedProcessingScope: CoroutineScope? = null) : WriteKeyValueRepo<String, File>

Files watching will not correctly works on Android with version of API lower than API 26

KeyValueRepo
Link copied to clipboard
interface KeyValueRepo<Key, Value> : ReadKeyValueRepo<Key, Value> , WriteKeyValueRepo<Key, Value>

Full version of standard key-value repository with all set/unset/clear/get methods

KeyValuesRepo
Link copied to clipboard
interface KeyValuesRepo<Key, Value> : ReadKeyValuesRepo<Key, Value> , WriteKeyValuesRepo<Key, Value>
MapCRUDRepo
Link copied to clipboard
abstract class MapCRUDRepo<ObjectType, IdType, InputValueType>(map: MutableMap<IdType, ObjectType>) : WriteMapCRUDRepo<ObjectType, IdType, InputValueType> , CRUDRepo<ObjectType, IdType, InputValueType> , ReadCRUDRepo<ObjectType, IdType>
MapKeyValueRepo
Link copied to clipboard
class MapKeyValueRepo<Key, Value>(map: MutableMap<Key, Value> = mutableMapOf()) : KeyValueRepo<Key, Value> , ReadKeyValueRepo<Key, Value> , WriteKeyValueRepo<Key, Value>
MapKeyValuesRepo
Link copied to clipboard
class MapKeyValuesRepo<Key, Value>(map: MutableMap<Key, MutableList<Value>> = mutableMapOf()) : KeyValuesRepo<Key, Value> , ReadKeyValuesRepo<Key, Value> , WriteKeyValuesRepo<Key, Value>
MapperRepo
Link copied to clipboard
interface MapperRepo<FromKey, FromValue, ToKey, ToValue>
MapReadKeyValuesRepo
Link copied to clipboard
class MapReadKeyValuesRepo<Key, Value>(map: Map<Key, List<Value>> = emptyMap()) : ReadKeyValuesRepo<Key, Value>
MapWriteKeyValuesRepo
Link copied to clipboard
class MapWriteKeyValuesRepo<Key, Value>(map: MutableMap<Key, MutableList<Value>> = mutableMapOf()) : WriteKeyValuesRepo<Key, Value>
OneToManyKeyValueRepo
Link copied to clipboard
typealias OneToManyKeyValueRepo<Key, Value> = KeyValuesRepo<Key, Value>
ReadCRUDRepo
Link copied to clipboard
interface ReadCRUDRepo<ObjectType, IdType> : Repo
ReadKeyValueRepo
Link copied to clipboard
interface ReadKeyValueRepo<Key, Value> : Repo

Read part of KeyValueRepo

ReadKeyValuesRepo
Link copied to clipboard
interface ReadKeyValuesRepo<Key, Value> : Repo
ReadMapCRUDRepo
Link copied to clipboard
class ReadMapCRUDRepo<ObjectType, IdType>(map: Map<IdType, ObjectType> = emptyMap()) : ReadCRUDRepo<ObjectType, IdType>
ReadMapKeyValueRepo
Link copied to clipboard
class ReadMapKeyValueRepo<Key, Value>(map: Map<Key, Value> = emptyMap()) : ReadKeyValueRepo<Key, Value>
ReadOneToManyKeyValueRepo
Link copied to clipboard
typealias ReadOneToManyKeyValueRepo<Key, Value> = ReadKeyValuesRepo<Key, Value>
ReadStandardCRUDRepo
Link copied to clipboard
typealias ReadStandardCRUDRepo<ObjectType, IdType> = ReadCRUDRepo<ObjectType, IdType>
ReadStandardKeyValueRepo
Link copied to clipboard
typealias ReadStandardKeyValueRepo<Key, Value> = ReadKeyValueRepo<Key, Value>
Repo
Link copied to clipboard
interface Repo
SimpleMapperRepo
Link copied to clipboard
class SimpleMapperRepo<FromKey, FromValue, ToKey, ToValue>(keyFromToTo: suspend FromKey.() -> ToKey, valueFromToTo: suspend FromValue.() -> ToValue, keyToToFrom: suspend ToKey.() -> FromKey, valueToToFrom: suspend ToValue.() -> FromValue) : MapperRepo<FromKey, FromValue, ToKey, ToValue>
StandardCRUDRepo
Link copied to clipboard
typealias StandardCRUDRepo<ObjectType, IdType, InputValueType> = CRUDRepo<ObjectType, IdType, InputValueType>
StandardKeyValueRepo
Link copied to clipboard
typealias StandardKeyValueRepo<Key, Value> = KeyValueRepo<Key, Value>
StandardSQLHelper
Link copied to clipboard
class StandardSQLHelper(context: Context, name: String, factory: SQLiteDatabase.CursorFactory? = null, version: Int = 1, errorHandler: DatabaseErrorHandler? = null, useSharedPreferencesForVersions: Boolean = false)
TransactionContext
Link copied to clipboard
class TransactionContext(val databaseContext: CoroutineContext) : CoroutineContext.Element
UpdatedValuePair
Link copied to clipboard
typealias UpdatedValuePair<IdType, ValueType> = Pair<IdType, ValueType>
WriteCRUDRepo
Link copied to clipboard
interface WriteCRUDRepo<ObjectType, IdType, InputValueType> : Repo
WriteKeyValueRepo
Link copied to clipboard
interface WriteKeyValueRepo<Key, Value> : Repo

Write part of KeyValueRepo

WriteKeyValuesRepo
Link copied to clipboard
interface WriteKeyValuesRepo<Key, Value> : Repo
WriteMapCRUDRepo
Link copied to clipboard
abstract class WriteMapCRUDRepo<ObjectType, IdType, InputValueType>(map: MutableMap<IdType, ObjectType> = mutableMapOf()) : WriteCRUDRepo<ObjectType, IdType, InputValueType>
WriteMapKeyValueRepo
Link copied to clipboard
class WriteMapKeyValueRepo<Key, Value>(map: MutableMap<Key, Value> = mutableMapOf()) : WriteKeyValueRepo<Key, Value>
WriteOneToManyKeyValueRepo
Link copied to clipboard
typealias WriteOneToManyKeyValueRepo<Key, Value> = WriteKeyValuesRepo<Key, Value>
WriteStandardCRUDRepo
Link copied to clipboard
typealias WriteStandardCRUDRepo<ObjectType, IdType, InputValueType> = WriteCRUDRepo<ObjectType, IdType, InputValueType>
WriteStandardKeyValueRepo
Link copied to clipboard
typealias WriteStandardKeyValueRepo<Key, Value> = WriteKeyValueRepo<Key, Value>

## Functions

add
Link copied to clipboard
inline suspend fun <Key, Value, REPO : WriteKeyValuesRepo<Key, Value>> REPO.add(vararg keysAndValues: Pair<Key, List<Value>>)
inline suspend fun <Key, Value, REPO : WriteKeyValuesRepo<Key, Value>> REPO.add(keysAndValues: List<Pair<Key, List<Value>>>)
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.add(k: Key, vararg v: Value)
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.add(k: Key, v: List<Value>)
asCrudRepo
Link copied to clipboard
fun <ObjectType, IdType, InputValueType> MutableMap<IdType, ObjectType>.asCrudRepo(updateCallback: suspend MutableMap<IdType, ObjectType>.(newValue: InputValueType, id: IdType, old: ObjectType) -> ObjectType, createCallback: suspend MutableMap<IdType, ObjectType>.(newValue: InputValueType) -> Pair<IdType, ObjectType>): MapCRUDRepo<ObjectType, IdType, newValue: InputValueType>
asKeyValueRepo
Link copied to clipboard
fun <K, V> MutableMap<K, V>.asKeyValueRepo(): KeyValueRepo<K, V>
asKeyValuesRepo
Link copied to clipboard
fun <K, V> MutableMap<K, List<V>>.asKeyValuesRepo(): KeyValuesRepo<K, V>
blockingReadableTransaction
Link copied to clipboard
fun <T> SQLiteOpenHelper.blockingReadableTransaction(block: SQLiteDatabase.() -> T): T
fun <T> StandardSQLHelper.blockingReadableTransaction(block: SQLiteDatabase.() -> T): T
blockingTransaction
Link copied to clipboard
fun <T> SQLiteDatabase.blockingTransaction(block: SQLiteDatabase.() -> T): T
blockingWritableTransaction
Link copied to clipboard
fun <T> SQLiteOpenHelper.blockingWritableTransaction(block: SQLiteDatabase.() -> T): T
fun <T> StandardSQLHelper.blockingWritableTransaction(block: SQLiteDatabase.() -> T): T
contentValuesOfNotNull
Link copied to clipboard
fun contentValuesOfNotNull(vararg pairs: Pair<String, Any?>?): ContentValues
create
Link copied to clipboard
suspend fun <ObjectType, IdType, InputValueType> WriteCRUDRepo<ObjectType, IdType, InputValueType>.create(vararg values: InputValueType): List<ObjectType>
createTable
Link copied to clipboard
fun SQLiteDatabase.createTable(tableName: String, vararg columnsToTypes: Pair<String, ColumnType>, onInit: SQLiteDatabase.() -> Unit? = null): Boolean
createTableQuery
Link copied to clipboard
fun createTableQuery(tableName: String, vararg columnsToTypes: Pair<String, ColumnType>): String
deleteById
Link copied to clipboard
suspend fun <ObjectType, IdType, InputValueType> WriteCRUDRepo<ObjectType, IdType, InputValueType>.deleteById(vararg ids: IdType)
firstOrNull
Link copied to clipboard
fun Cursor.firstOrNull(): Cursor?
getDouble
Link copied to clipboard
fun Cursor.getDouble(columnName: String): Double
getDoubleOrNull
Link copied to clipboard
fun Cursor.getDoubleOrNull(columnName: String): Double?
getFloat
Link copied to clipboard
fun Cursor.getFloat(columnName: String): Float
getFloatOrNull
Link copied to clipboard
fun Cursor.getFloatOrNull(columnName: String): Float?
getInt
Link copied to clipboard
fun Cursor.getInt(columnName: String): Int
getIntOrNull
Link copied to clipboard
fun Cursor.getIntOrNull(columnName: String): Int?
getLong
Link copied to clipboard
fun Cursor.getLong(columnName: String): Long
getLongOrNull
Link copied to clipboard
fun Cursor.getLongOrNull(columnName: String): Long?
getShort
Link copied to clipboard
fun Cursor.getShort(columnName: String): Short
getShortOrNull
Link copied to clipboard
fun Cursor.getShortOrNull(columnName: String): Short?
getString
Link copied to clipboard
fun Cursor.getString(columnName: String): String
getStringOrNull
Link copied to clipboard
fun Cursor.getStringOrNull(columnName: String): String?
inlineTransaction
Link copied to clipboard
inline fun <T> SQLiteDatabase.inlineTransaction(crossinline block: SQLiteDatabase.() -> T): T
invoke
Link copied to clipboard
operator fun <FromKey, FromValue, ToKey, ToValue> MapperRepo.Companion.invoke(keyFromToTo: suspend FromKey.() -> ToKey, valueFromToTo: suspend FromValue.() -> ToValue, keyToToFrom: suspend ToKey.() -> FromKey, valueToToFrom: suspend ToValue.() -> FromValue): SimpleMapperRepo<FromKey, FromValue, ToKey, ToValue>
iterator
Link copied to clipboard
operator fun Cursor.iterator(): CursorIterator
limitClause
Link copied to clipboard
fun Pagination.limitClause(): String
fun limitClause(size: Int, since: Int? = null): String
fun limitClause(size: Long, since: Long? = null): String
makePlaceholders
Link copied to clipboard
fun makePlaceholders(count: Int): String
makeStringPlaceholders
Link copied to clipboard
fun makeStringPlaceholders(count: Int): String
map
Link copied to clipboard
inline fun <T> Cursor.map(block: (Cursor) -> T): List<T>
MapCRUDRepo
Link copied to clipboard
fun <ObjectType, IdType, InputValueType> MapCRUDRepo(updateCallback: suspend MutableMap<IdType, ObjectType>.(newValue: InputValueType, id: IdType, old: ObjectType) -> ObjectType, createCallback: suspend MutableMap<IdType, ObjectType>.(newValue: InputValueType) -> Pair<IdType, ObjectType>): MapCRUDRepo<ObjectType, IdType, newValue: InputValueType>
fun <ObjectType, IdType, InputValueType> MapCRUDRepo(map: MutableMap<IdType, ObjectType>, updateCallback: suspend MutableMap<IdType, ObjectType>.(newValue: InputValueType, id: IdType, old: ObjectType) -> ObjectType, createCallback: suspend MutableMap<IdType, ObjectType>.(newValue: InputValueType) -> Pair<IdType, ObjectType>): MapCRUDRepo<ObjectType, IdType, InputValueType>
mapper
Link copied to clipboard
inline fun <FromKey, FromValue, ToKey, ToValue> mapper(noinline keyFromToTo: suspend FromKey.() -> ToKey = { this as ToKey }, noinline valueFromToTo: suspend FromValue.() -> ToValue = { this as ToValue }, noinline keyToToFrom: suspend ToKey.() -> FromKey = { this as FromKey }, noinline valueToToFrom: suspend ToValue.() -> FromValue = { this as FromValue }): SimpleMapperRepo<FromKey, FromValue, ToKey, ToValue>
readableTransaction
Link copied to clipboard
suspend fun <T> SQLiteOpenHelper.readableTransaction(block: suspend SQLiteDatabase.() -> T): T
remove
Link copied to clipboard
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.remove(vararg keysAndValues: Pair<Key, List<Value>>)
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.remove(keysAndValues: List<Pair<Key, List<Value>>>)
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.remove(k: Key, vararg v: Value)
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.remove(k: Key, v: List<Value>)
select
Link copied to clipboard
fun SQLiteDatabase.select(table: String, columns: Array<String>? = null, selection: String? = null, selectionArgs: Array<String>? = null, groupBy: String? = null, having: String? = null, orderBy: String? = null, limit: String? = null): Cursor
selectDistinct
Link copied to clipboard
fun SQLiteDatabase.selectDistinct(table: String, columns: Array<String>? = null, selection: String? = null, selectionArgs: Array<String>? = null, groupBy: String? = null, having: String? = null, orderBy: String? = null, limit: String? = null): Cursor
set
Link copied to clipboard
inline suspend fun <Key, Value, REPO : WriteKeyValuesRepo<Key, Value>> REPO.set(vararg keysAndValues: Pair<Key, List<Value>>)
inline suspend fun <Key, Value, REPO : WriteKeyValuesRepo<Key, Value>> REPO.set(keysAndValues: List<Pair<Key, List<Value>>>)
inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.set(vararg toSet: Pair<Key, Value>)
inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.set(k: Key, v: Value)
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.set(k: Key, vararg v: Value)
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.set(k: Key, v: List<Value>)
transaction
Link copied to clipboard
suspend fun <T> SQLiteDatabase.transaction(block: suspend SQLiteDatabase.() -> T): T
unset
Link copied to clipboard
inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.unset(vararg k: Key)
unsetWithValues
Link copied to clipboard
inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.unsetWithValues(vararg v: Value)
update
Link copied to clipboard
suspend fun <ObjectType, IdType, InputValueType> WriteCRUDRepo<ObjectType, IdType, InputValueType>.update(vararg values: UpdatedValuePair<IdType, InputValueType>): List<ObjectType>
writableTransaction
Link copied to clipboard
suspend fun <T> SQLiteOpenHelper.writableTransaction(block: suspend SQLiteDatabase.() -> T): T

## Properties

DatabaseCoroutineContext
Link copied to clipboard
val DatabaseCoroutineContext: CoroutineContext
id
Link copied to clipboard
val <IdType> UpdatedValuePair<IdType, *>.id: IdType
internalId
Link copied to clipboard
val internalId: String
internalIdType
Link copied to clipboard
val internalIdType: ColumnType.Numeric.INTEGER
value
Link copied to clipboard
val <ValueType> UpdatedValuePair<*, ValueType>.value: ValueType