Cursor.kt
/*
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@file:Suppress("NOTHING_TO_INLINE") // Aliases to other public API.
package androidx.core.database
import android.database.Cursor
/**
* Returns the value of the requested column as a byte array.
*
* The result and whether this method throws an exception when the column value is null or the
* column type is not a blob type is implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.getBlob
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getBlob(columnName: String): ByteArray =
getBlob(getColumnIndexOrThrow(columnName))
/**
* Returns the value of the requested column as a double.
*
* The result and whether this method throws an exception when the column value is null or the
* column type is not a floating-point type is implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.getDouble
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getDouble(columnName: String): Double =
getDouble(getColumnIndexOrThrow(columnName))
/**
* Returns the value of the requested column as a float.
*
* The result and whether this method throws an exception when the column value is null or the
* column type is not a floating-point type is implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.getFloat
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getFloat(columnName: String): Float = getFloat(getColumnIndexOrThrow(columnName))
/**
* Returns the value of the requested column as an integer.
*
* The result and whether this method throws an exception when the column value is null or the
* column type is not an integral type is implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.getInt
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getInt(columnName: String): Int = getInt(getColumnIndexOrThrow(columnName))
/**
* Returns the value of the requested column as a long.
*
* The result and whether this method throws an exception when the column value is null or the
* column type is not an integral type is implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.getLong
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getLong(columnName: String): Long = getLong(getColumnIndexOrThrow(columnName))
/**
* Returns the value of the requested column as a short.
*
* The result and whether this method throws an exception when the column value is null or the
* column type is not an integral type is implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.getShort
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getShort(columnName: String): Short = getShort(getColumnIndexOrThrow(columnName))
/**
* Returns the value of the requested column as a string.
*
* The result and whether this method throws an exception when the column value is null or the
* column type is not a string type is implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.getString
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getString(columnName: String): String =
getString(getColumnIndexOrThrow(columnName))
/**
* Returns the value of the requested column as a nullable byte array.
*
* The result and whether this method throws an exception when the column type is not a blob type is
* implementation-defined.
*
* @see Cursor.isNull
* @see Cursor.getBlob
*/
inline fun Cursor.getBlobOrNull(index: Int) = if (isNull(index)) null else getBlob(index)
/**
* Returns the value of the requested column as a nullable double.
*
* The result and whether this method throws an exception when the column type is not a
* floating-point type is implementation-defined.
*
* @see Cursor.isNull
* @see Cursor.getDouble
*/
inline fun Cursor.getDoubleOrNull(index: Int) = if (isNull(index)) null else getDouble(index)
/**
* Returns the value of the requested column as a nullable float.
*
* The result and whether this method throws an exception when the column type is not a
* floating-point type is implementation-defined.
*
* @see Cursor.isNull
* @see Cursor.getFloat
*/
inline fun Cursor.getFloatOrNull(index: Int) = if (isNull(index)) null else getFloat(index)
/**
* Returns the value of the requested column as a nullable integer.
*
* The result and whether this method throws an exception when the column type is not an integral
* type is implementation-defined.
*
* @see Cursor.isNull
* @see Cursor.getInt
*/
inline fun Cursor.getIntOrNull(index: Int) = if (isNull(index)) null else getInt(index)
/**
* Returns the value of the requested column as a nullable long.
*
* The result and whether this method throws an exception when the column type is not an integral
* type is implementation-defined.
*
* @see Cursor.isNull
* @see Cursor.getLong
*/
inline fun Cursor.getLongOrNull(index: Int) = if (isNull(index)) null else getLong(index)
/**
* Returns the value of the requested column as a nullable short.
*
* The result and whether this method throws an exception when the column type is not an integral
* type is implementation-defined.
*
* @see Cursor.isNull
* @see Cursor.getShort
*/
inline fun Cursor.getShortOrNull(index: Int) = if (isNull(index)) null else getShort(index)
/**
* Returns the value of the requested column as a nullable string.
*
* The result and whether this method throws an exception when the column type is not a string type
* is implementation-defined.
*
* @see Cursor.isNull
* @see Cursor.getString
*/
inline fun Cursor.getStringOrNull(index: Int) = if (isNull(index)) null else getString(index)
/**
* Returns the value of the requested column as a nullable byte array.
*
* The result and whether this method throws an exception when the column type is not a blob type is
* implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.isNull
* @see Cursor.getBlob
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getBlobOrNull(columnName: String) =
getColumnIndexOrThrow(columnName).let { if (isNull(it)) null else getBlob(it) }
/**
* Returns the value of the requested column as a nullable double.
*
* The result and whether this method throws an exception when the column type is not a
* floating-point type is implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.isNull
* @see Cursor.getDouble
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getDoubleOrNull(columnName: String) =
getColumnIndexOrThrow(columnName).let { if (isNull(it)) null else getDouble(it) }
/**
* Returns the value of the requested column as a nullable float.
*
* The result and whether this method throws an exception when the column type is not a
* floating-point type is implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.isNull
* @see Cursor.getFloat
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getFloatOrNull(columnName: String) =
getColumnIndexOrThrow(columnName).let { if (isNull(it)) null else getFloat(it) }
/**
* Returns the value of the requested column as a nullable integer.
*
* The result and whether this method throws an exception when the column type is not an integral
* type is implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.isNull
* @see Cursor.getInt
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getIntOrNull(columnName: String) =
getColumnIndexOrThrow(columnName).let { if (isNull(it)) null else getInt(it) }
/**
* Returns the value of the requested column as a nullable long.
*
* The result and whether this method throws an exception when the column type is not an integral
* type is implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.isNull
* @see Cursor.getLong
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getLongOrNull(columnName: String) =
getColumnIndexOrThrow(columnName).let { if (isNull(it)) null else getLong(it) }
/**
* Returns the value of the requested column as a nullable short.
*
* The result and whether this method throws an exception when the column type is not an integral
* type is implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.isNull
* @see Cursor.getShort
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getShortOrNull(columnName: String) =
getColumnIndexOrThrow(columnName).let { if (isNull(it)) null else getShort(it) }
/**
* Returns the value of the requested column as a nullable string.
*
* The result and whether this method throws an exception when the column type is not a string type
* is implementation-defined.
*
* @see Cursor.getColumnIndexOrThrow
* @see Cursor.isNull
* @see Cursor.getString
*/
@Deprecated(
"Use an abstraction like Room or look up column names once prior to iteration",
level = DeprecationLevel.ERROR
)
inline fun Cursor.getStringOrNull(columnName: String) =
getColumnIndexOrThrow(columnName).let { if (isNull(it)) null else getString(it) }