docs: 更新 API 文档

Former-commit-id: 3eb5288
afkT · Jun 25, 2022 · aecd3dd · aecd3dd
1 parent 04b36c0
commit aecd3dd
Show file tree

Hide file tree

Showing 5 changed files with 110 additions and 79 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 
 [![GitHub](https://img.shields.io/badge/GitHub-afkT-blue.svg)](https://github.com/afkT)
 [![GitHub license](https://img.shields.io/github/license/afkT/DevUtils.svg)](https://github.com/afkT/DevUtils/blob/master/LICENSE)
-[![MavenCentral](https://img.shields.io/badge/DevUtils-2.3.8-brightgreen.svg)](https://search.maven.org/search?q=io.github.afkt)
+[![MavenCentral](https://img.shields.io/badge/DevUtils-2.3.9-brightgreen.svg)](https://search.maven.org/search?q=io.github.afkt)
 [![API](https://img.shields.io/badge/API-14%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=14)
 [![Utils](https://img.shields.io/badge/utils-200+-ff69b4.svg)](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/README.md)
 
@@ -113,7 +113,7 @@
 ```gradle
 
 // DevApp - Android 工具类库
-implementation 'io.github.afkt:DevAppX:2.3.8'
+implementation 'io.github.afkt:DevAppX:2.3.9'
 
 // DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
 implementation 'io.github.afkt:DevAssist:1.3.5'
@@ -150,7 +150,7 @@ releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.0'
 //annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.0' // kapt
 
 // DevJava - Java 工具类库 ( 不依赖 android api )
-implementation 'io.github.afkt:DevJava:1.4.4' // 用于纯 Java 开发，如果依赖了 DevApp 则不需要依赖 DevJava
+implementation 'io.github.afkt:DevJava:1.4.5' // 用于纯 Java 开发，如果依赖了 DevApp 则不需要依赖 DevJava
 ```
 
 ## [APK Demo](https://github.com/afkT/Resources/blob/main/APK)

diff --git a/lib/DevApp/README.md b/lib/DevApp/README.md
@@ -6,7 +6,7 @@
 //implementation 'com.afkt:DevApp:1.9.4'
 
 // AndroidX ( Maven Central ) 
-implementation 'io.github.afkt:DevAppX:2.3.8'
+implementation 'io.github.afkt:DevAppX:2.3.9'
 ```
 
 ## 目录结构
@@ -17,6 +17,7 @@ implementation 'io.github.afkt:DevAppX:2.3.8'
  - activity_result | Activity Result API
  - anim | 动画工具类
  - assist | 辅助类
+ - exif | 图片 EXIF 读写辅助类
  - floating | 悬浮窗实现方案辅助类
  - lifecycle | Activity 生命周期监听辅助类
  - record | 文件记录分析类
@@ -105,6 +106,7 @@ DevUtils.openDebug();
  - [activity_result](#devutilsappactivity_result) | Activity Result API
  - [anim](#devutilsappanim) | 动画工具类
  - [assist](#devutilsappassist) | 辅助类
+ - [exif](#devutilsappassistexif) | 图片 EXIF 读写辅助类
  - [floating](#devutilsappassistfloating) | 悬浮窗实现方案辅助类
  - [lifecycle](#devutilsappassistlifecycle) | Activity 生命周期监听辅助类
  - [record](#devutilsappassistrecord) | 文件记录分析类
@@ -734,6 +736,7 @@ DevUtils.openDebug();
 | closeDialogs | 关闭多个 Dialog |
 | closePopupWindow | 关闭 PopupWindow |
 | closePopupWindows | 关闭多个 PopupWindow |
+| showDialogAndCloses | 显示 Dialog 并关闭其他 Dialog |
 | createAlertDialog | 创建提示 Dialog ( 原生样式 ) |
 | createProgressDialog | 创建加载中 Dialog ( 原生样式 ) |
 | autoCloseDialog | 自动关闭 dialog |
@@ -2427,6 +2430,68 @@ DevUtils.openDebug();
 | setStatusBarColorAndFlag | 设置状态栏颜色、高版本状态栏蒙层 |
 
 
+## <span id="devutilsappassistexif">**`dev.utils.app.assist.exif`**</span>
+
+
+* **图片 EXIF 读写辅助类 ->** [ExifAssist.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/app/assist/exif/ExifAssist.java)
+
+| 方法 | 注释 |
+| :- | :- |
+| get | get |
+| getByRequire | 创建可获取 EXIF 敏感信息辅助类 |
+| requireOriginal | 获取 EXIF 敏感信息, 请求获取原始 Uri |
+| requestPermission | 请求 ACCESS_MEDIA_LOCATION 权限并进行通知 |
+| isSupportedMimeType | 判断是否支持读取的资源类型 |
+| clone | 克隆图片 EXIF 读写信息 |
+| getExif | 获取图片 EXIF 操作接口 |
+| getExifError | 获取 EXIF 初始化异常信息 |
+| isExifNull | 是否图片 EXIF 为 null |
+| isExifNotNull | 是否图片 EXIF 不为 null |
+| isExifError | 是否 EXIF 初始化异常 |
+| getAttributeInt | 根据 TAG 获取对应值 |
+| getAttributeDouble | 根据 TAG 获取对应值 |
+| getAttribute | 根据 TAG 获取对应值 |
+| getAttributeBytes | 根据 TAG 获取对应值 |
+| getAttributeRange | 根据 TAG 获取对应值 |
+| hasAttribute | 是否存在指定 TAG 值 |
+| setAttribute | 设置对应 TAG 值 |
+| saveAttributes | 将标签数据存储到图片中 ( 最终必须调用 ) |
+| eraseAllExif | 擦除图像 Exif 信息 ( 全部 ) |
+| eraseExifByList | 擦除图像 Exif 信息 ( 指定集合 ) |
+| eraseExifByArray | 擦除图像 Exif 信息 ( 指定数组 ) |
+| eraseExifLocation | 擦除图像所有 GPS 位置信息 |
+| existLocation | 是否存在 GPS 位置信息 |
+| getLatLong | 获取经纬度信息 |
+| setLatLong | 设置经纬度信息 |
+| getGpsInfo | 获取 GPS 信息 |
+| setGpsInfo | 设置 GPS 信息 |
+| getGpsDateTime | 获取 GPS 定位时间信息 |
+| getAltitude | 获取海拔高度信息 ( 单位米 ) |
+| setAltitude | 设置海拔高度信息 |
+| hasThumbnail | 是否存在缩略图 |
+| isThumbnailCompressed | 是否存在 JPEG 压缩缩略图 |
+| getThumbnail | 获取 JPEG 压缩缩略图 |
+| getThumbnailBytes | 获取 Exif 缩略图 |
+| getThumbnailBitmap | 获取 Exif 缩略图 |
+| getThumbnailRange | 获取缩略图数据偏移量位置和长度信息 |
+| isFlipped | 当前图片是否翻转 |
+| flipHorizontally | 进行水平翻转图片 |
+| flipVertically | 进行垂直翻转图片 |
+| getRotationDegrees | 获取图片旋转角度 |
+| rotate | 将图片顺时针旋转给定度数 |
+| resetOrientation | 重置图片方向为默认方向 |
+| getAttributeByGroup | 获取 Exif 信息 ( ExifTag Group ) |
+| getAttributeByList | 获取 Exif 信息 ( 指定集合 ) |
+| getAttributeByArray | 获取 Exif 信息 ( 指定数组 ) |
+
+
+* **图片 EXIF Tag Group 常量类 ->** [ExifTag.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/app/assist/exif/ExifTag.java)
+
+| 方法 | 注释 |
+| :- | :- |
+| asList | 快捷创建 List 简化 add 操作 |
+
+
 ## <span id="devutilsappassistfloating">**`dev.utils.app.assist.floating`**</span>
 
 
@@ -4053,7 +4118,7 @@ DevUtils.openDebug();
 | recode | 重新编码 Bitmap |
 | recycle | Bitmap 通知回收 |
 | rotate | 旋转图片 |
-| getRotateDegree | 读取图片属性, 获取图片被旋转的角度 |
+| getRotationDegrees | 读取图片属性, 获取图片旋转角度 |
 | reverseByHorizontal | 水平翻转图片 ( 左右颠倒 ) |
 | reverseByVertical | 垂直翻转图片 ( 上下颠倒 ) |
 | reverse | 翻转图片 |
@@ -5466,6 +5531,7 @@ DevUtils.openDebug();
 | length | 获取字符串长度 |
 | isLength | 获取字符串长度 是否等于期望长度 |
 | equals | 判断两个值是否一样 |
+| equalsNotNull | 判断两个值是否一样 ( 非 null 判断 ) |
 | isEquals | 判断多个字符串是否相等, 只有全相等才返回 true ( 对比大小写 ) |
 | isOrEquals | 判断多个字符串, 只要有一个符合条件则通过 |
 | isContains | 判断一堆值中, 是否存在符合该条件的 ( 包含 ) |

diff --git a/lib/DevEngine/README.md b/lib/DevEngine/README.md
@@ -8,17 +8,18 @@ implementation 'io.github.afkt:DevEngine:1.0.7'
 ## 目录结构
 
 ```
-- dev.engine | 根目录
- - barcode | BarCode Engine 条形码、二维码处理
- - cache | Cache Engine 有效期键值对缓存
- - compress | Image Compress Engine 图片压缩
- - image | Image Engine 图片加载、下载、转格式等
- - json | JSON Engine 映射
- - keyvalue | KeyValue Engine 键值对存储
- - log | Log Engine 日志打印
- - media | Media Selector Engine 多媒体资源选择
- - permission | Permission Engine 权限申请
- - storage | Storage Engine 外部、内部文件存储
+- dev.engine | 根目录
+ - barcode | BarCode Engine 条形码、二维码处理
+ - cache | Cache Engine 有效期键值对缓存
+ - compress | Image Compress Engine 图片压缩
+ - image | Image Engine 图片加载、下载、转格式等
+ - json | JSON Engine 映射
+ - keyvalue | KeyValue Engine 键值对存储
+ - log | Log Engine 日志打印
+ - media | Media Selector Engine 多媒体资源选择
+ - luck_lib_engine | LuckSiege PictureSelector Engine 实现
+ - permission | Permission Engine 权限申请
+ - storage | Storage Engine 外部、内部文件存储
 ```
 
 

diff --git a/lib/DevJava/README.md b/lib/DevJava/README.md
@@ -2,7 +2,7 @@
 ## Gradle
 
 ```gradle
-implementation 'io.github.afkt:DevJava:1.4.4'
+implementation 'io.github.afkt:DevJava:1.4.5'
 ```
 
 ## 目录结构
@@ -923,6 +923,7 @@ JCLogUtils.setPrint(new JCLogUtils.Print() {});
 | length | 获取字符串长度 |
 | isLength | 获取字符串长度 是否等于期望长度 |
 | equals | 判断两个值是否一样 |
+| equalsNotNull | 判断两个值是否一样 ( 非 null 判断 ) |
 | isEquals | 判断多个字符串是否相等, 只有全相等才返回 true ( 对比大小写 ) |
 | isOrEquals | 判断多个字符串, 只要有一个符合条件则通过 |
 | isContains | 判断一堆值中, 是否存在符合该条件的 ( 包含 ) |

diff --git a/lib/LocalModules/DevOther/README.md b/lib/LocalModules/DevOther/README.md
@@ -19,6 +19,7 @@
  - keyvalue | KeyValue Engine 键值对存储
  - log | Log Engine 日志打印
  - media | Media Selector Engine 多媒体资源选择
+ - luck_lib_engine| LuckSiege PictureSelector Engine 实现
  - permission | Permission Engine 权限申请
  - storage | Storage Engine 外部、内部文件存储
  - other | 第三方库封装工具类
@@ -64,6 +65,7 @@
  - [keyvalue](#javadevenginekeyvalue) | KeyValue Engine 键值对存储
  - [log](#javadevenginelog) | Log Engine 日志打印
  - [media](#javadevenginemedia) | Media Selector Engine 多媒体资源选择
+ - [luck_lib_engine](#javadevenginemedialuck_lib_engine)| LuckSiege PictureSelector Engine 实现
  - [permission](#javadevenginepermission) | Permission Engine 权限申请
  - [storage](#javadevenginestorage) | Storage Engine 外部、内部文件存储
  - [other](#javadevother) | 第三方库封装工具类
@@ -527,16 +529,6 @@
 ## <span id="javadevenginemedia">**`java.dev.engine.media`**</span>
 
 
-* ** ->** [GlideEngine.java](https://github.com/afkT/DevUtils/blob/master/lib/LocalModules/DevOther/src/main/java//java/dev/engine/media/GlideEngine.java)
-
-| 方法 | 注释 |
-| :- | :- |
-| loadImage | 加载图片 |
-| loadFolderImage | 加载相册目录 |
-| loadGridImage | 加载图片列表图片 |
-| createGlideEngine | createGlideEngine |
-
-
 * **Local Media Selector Data ->** [LocalMediaData.java](https://github.com/afkT/DevUtils/blob/master/lib/LocalModules/DevOther/src/main/java//java/dev/engine/media/LocalMediaData.java)
 
 | 方法 | 注释 |
@@ -610,6 +602,19 @@
 | getSingleSelectorPath | getSingleSelectorPath |
 
 
+## <span id="javadevenginemedialuck_lib_engine">**`java.dev.engine.media.luck_lib_engine`**</span>
+
+
+* ** ->** [LuckGlideEngineImpl.java](https://github.com/afkT/DevUtils/blob/master/lib/LocalModules/DevOther/src/main/java//java/dev/engine/media/luck_lib_engine/LuckGlideEngineImpl.java)
+
+| 方法 | 注释 |
+| :- | :- |
+| loadImage | 加载图片 |
+| loadFolderImage | 加载相册目录 |
+| loadGridImage | 加载图片列表图片 |
+| createGlideEngine | createGlideEngine |
+
+
 ## <span id="javadevenginepermission">**`java.dev.engine.permission`**</span>
 
 
@@ -732,15 +737,6 @@
 | getType | 获取 Type |
 
 
-* **Glide 图形处理工具类 ->** [GlideTransformUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/LocalModules/DevOther/src/main/java//java/dev/other/GlideTransformUtils.java)
-
-| 方法 | 注释 |
-| :- | :- |
-| transform | transform |
-| updateDiskCacheKey | updateDiskCacheKey |
-| blurBitmap | 模糊图片处理 |
-
-
 * **Glide 工具类 ->** [GlideUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/LocalModules/DevOther/src/main/java//java/dev/other/GlideUtils.java)
 
 | 方法 | 注释 |
@@ -861,55 +857,22 @@
 
 | 方法 | 注释 |
 | :- | :- |
-| getConfig | 获取全局相册配置 |
-| setConfig | 设置全局相册配置 |
+| openCamera | 打开相册拍照 |
+| openGallery | 打开相册选择 |
+| getConfig | 获取全局配置 |
+| setConfig | 设置全局配置 |
 | getCameraSavePath | 获取拍照存储地址 |
 | getCompressSavePath | 获取压缩图片存储地址 |
 | setSavePath | 设置存储地址 |
 | getMinimumCompressSize | 获取图片大于多少才进行压缩 ( kb ) |
 | setMinimumCompressSize | 设置图片大于多少才进行压缩 ( kb ) |
-| deleteCacheDirFile | 清空缓存 |
-| deleteAllCacheDirFile | 清空全部缓存 |
+| deleteCacheDirFile | 删除缓存文件 |
+| deleteAllCacheDirFile | 删除全部缓存文件 |
 | isMediaSelectorResult | 是否图片选择 ( onActivityResult ) |
-| getLocalMedias | 获取选中的资源集合 |
-| getSingleMedia | 获取单独选中的资源 |
-| getLocalMediaPath | 获取本地资源路径 |
-| getLocalMediaPaths | 获取本地资源地址集合 |
-| getPictureSelectionModel | 获取图片选择配置模型 |
-| openCamera | 打开相册拍照 |
-| openGallery | 打开相册选择 |
-| getMimeType | 获取相册选择类型 |
-| setMimeType | 设置相册选择类型 |
-| getSelectionMode | 获取相册选择模式 |
-| setSelectionMode | 设置相册选择模式 |
-| isCamera | 是否显示拍照 |
-| setCamera | 设置是否显示拍照 |
-| isCrop | 是否裁减 |
-| setCrop | 设置是否裁减 |
-| isCircleCrop | 是否圆形裁减 |
-| setCircleCrop | 设置是否圆形裁减 |
-| isCompress | 是否压缩 |
-| setCompress | 设置是否压缩 |
-| getWithAspectRatio | 获取裁减比例 |
-| setWithAspectRatio | 设置裁减比例 |
-| isGif | 是否显示 Gif |
-| setGif | 设置是否显示 Gif |
-| getImageSpanCount | 获取每行显示个数 |
-| setImageSpanCount | 设置每行显示个数 |
-| getMinSelectNum | 获取最小选择数量 |
-| setMinSelectNum | 设置最小选择数量 |
-| getMaxSelectNum | 获取最大选择数量 |
-| setMaxSelectNum | 设置最大选择数量 |
-| getLocalMedia | 获取已选择的本地资源 |
-| setLocalMedia | 设置已选择的本地资源 |
-| setCameraSavePath | 设置拍照存储地址 |
-| setCompressSavePath | 设置压缩图片存储地址 |
-| clone | 克隆新的配置信息 |
-| set | 设置新的配置信息 |
-| ofAll | ofAll |
-| ofImage | ofImage |
-| ofVideo | ofVideo |
-| ofAudio | ofAudio |
+| getSelectors | 获取 Media Selector Data List |
+| getSelectorPaths | 获取 Media Selector Path List |
+| getSingleSelector | 获取 Single Media Selector Data |
+| getSingleSelectorPath | 获取 Single Media Selector Path |
 
 
 * **ZXing 条形码、二维码工具类 ->** [ZXingUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/LocalModules/DevOther/src/main/java//java/dev/other/ZXingUtils.java)