1 /*
2  * Copyright 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 androidx.camera.integration.diagnose
18 
19 import android.content.Context
20 import androidx.camera.view.LifecycleCameraController
21 
22 /**
23  * Abstract DiagnosisTask for running custom task through diagnose in {@link Diagnosis} on device
24  * and store results to a {@link DataStore}.
25  */
26 abstract class DiagnosisTask(private val name: String) {
getTaskNamenull27     fun getTaskName(): String {
28         return name
29     }
30 
31     /**
32      * Called by diagnose function in {@link Diagnosis} to execute tasks implemented by children.
33      * Children can use {@link LifecycleCameraController} to access CameraX features on the device
34      * and use @{link DataStore} to save results to a report file.
35      */
runDiagnosisTasknull36     abstract suspend fun runDiagnosisTask(
37         cameraController: LifecycleCameraController,
38         dataStore: DataStore,
39         context: Context
40     )
41 }
42