1 /*
2  * Copyright (C) 2022 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.quicksearchbox.util
18 
19 import android.database.sqlite.SQLiteDatabase
20 
21 /** Abstract helper base class for SQLite write transactions. */
22 abstract class SQLiteTransaction {
23   /**
24    * Executes the statements that form the transaction.
25    *
26    * @param db A writable database.
27    * @return `true` if the transaction should be committed.
28    */
performTransactionnull29   protected abstract fun performTransaction(db: SQLiteDatabase?): Boolean
30 
31   /**
32    * Runs the transaction against the database. The results are committed if [.performTransaction]
33    * completes normally and returns `true`.
34    */
35   fun run(db: SQLiteDatabase) {
36     db.beginTransaction()
37     try {
38       if (performTransaction(db)) {
39         db.setTransactionSuccessful()
40       }
41     } finally {
42       db.endTransaction()
43     }
44   }
45 }
46