1 /*
2  * Copyright (C) 2019 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.providers.media.scan;
18 
19 import static com.android.providers.media.MediaProviderStatsLog.MEDIA_PROVIDER_SCAN_OCCURRED__REASON__DEMAND;
20 import static com.android.providers.media.MediaProviderStatsLog.MEDIA_PROVIDER_SCAN_OCCURRED__REASON__IDLE;
21 import static com.android.providers.media.MediaProviderStatsLog.MEDIA_PROVIDER_SCAN_OCCURRED__REASON__MOUNTED;
22 import static com.android.providers.media.MediaProviderStatsLog.MEDIA_PROVIDER_SCAN_OCCURRED__REASON__UNKNOWN;
23 
24 import android.content.Context;
25 import android.net.Uri;
26 
27 import androidx.annotation.IntDef;
28 import androidx.annotation.NonNull;
29 import androidx.annotation.Nullable;
30 
31 import com.android.providers.media.MediaVolume;
32 
33 import java.io.File;
34 import java.lang.annotation.Retention;
35 import java.lang.annotation.RetentionPolicy;
36 
37 public interface MediaScanner {
38     int REASON_UNKNOWN = MEDIA_PROVIDER_SCAN_OCCURRED__REASON__UNKNOWN;
39     int REASON_MOUNTED = MEDIA_PROVIDER_SCAN_OCCURRED__REASON__MOUNTED;
40     int REASON_DEMAND = MEDIA_PROVIDER_SCAN_OCCURRED__REASON__DEMAND;
41     int REASON_IDLE = MEDIA_PROVIDER_SCAN_OCCURRED__REASON__IDLE;
42 
43     @Retention(RetentionPolicy.SOURCE)
44     @IntDef(value = {
45             REASON_UNKNOWN,
46             REASON_MOUNTED,
47             REASON_DEMAND,
48             REASON_IDLE
49     })
50     @interface ScanReason {}
51 
52     @NonNull
getContext()53     Context getContext();
54 
scanDirectory(@onNull File dir, @ScanReason int reason)55     void scanDirectory(@NonNull File dir, @ScanReason int reason);
56 
57     @Nullable
scanFile(@onNull File file, @ScanReason int reason)58     Uri scanFile(@NonNull File file, @ScanReason int reason);
59 
onDetachVolume(@onNull MediaVolume volume)60     void onDetachVolume(@NonNull MediaVolume volume);
61 
onIdleScanStopped()62     void onIdleScanStopped();
63 
onDirectoryDirty(@onNull File file)64     void onDirectoryDirty(@NonNull File file);
65 }
66