aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: f918f2aa2955d065b09e93909d14537e92cc36a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# Oh My SAF

Android [SAF](https://developer.android.com/guide/topics/providers/document-provider) helper.

# Implement

1. Add [maven.yuuta.moe](https://maven.yuuta.moe) repo to your module

2. Add dependency:

```grooxy
implementation 'moe.yuuta.ohmysaf:ohmysaf:<the latest version>'
```

# Main Features

* Faster migrate - If you have an old project which uses `java.io.File` a lot and you would like to migrate to SAF, OMG. By using OhMySAF, you can just continue using `File` with a little hack.

# Faster Migrate

Imagine that you have an old project and its file operation codes look like:

```java
File theFxxkFile = new File("xxx/xxx");
if (theFxxkFile.isFile()) {
    theFxxkFile.delete();
    theFxxkFile.mkdir(); // In fact, SAF does not support that.
}
```

If you want to switch to SAF, the normal code will look like:

```java
// Assume that you've got the URI
DocumentFile theFxxkFile = DocumentFile.fromTreeUri(context, uri);
if (theFxxkFile.isFile()) {
    theFxxkFile.delete();
    // .....
}
```

One day you discovered `OhMySAF`, your problem is solved:

```java
// Assume that you've got the URI

// Magic
File theFxxkFile = OhMySAF.ohMyTree(context, uri);

// Just KEEP these old codes!
if (theFxxkFile.isFile()) {
    theFxxkFile.delete();
    theFxxkFile.mkdir(); // In fact, SAF does not support that.
}
```

# Licenses

Apache 2.0