forked from afkT/JavaDoc
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathApiConfig.java
More file actions
451 lines (379 loc) · 21.1 KB
/
ApiConfig.java
File metadata and controls
451 lines (379 loc) · 21.1 KB
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
package javadoc.dev_utils;
import java.io.File;
import java.util.HashMap;
/**
* detail: 配置信息
* @author Ttt
*/
public final class ApiConfig {
private ApiConfig() {
}
// 项目名
public static final String PROJECT_NAME = "DevUtils";
// 文件保存路径
public static final String FILE_SAVE_PATH = "D:/API/";
// 本地路径
public static final String LOCAL_PATH = "F:/Project/Android/Utils";
// 项目路径
public static final String PROJECT_PATH = LOCAL_PATH + File.separator + PROJECT_NAME;
// 包目录名
public static final String DEV_PACKAGE = "dev.utils";
// 作者 Github 地址
public static final String GITHUB_AUTHOR_URL = "https://github.com/afkT";
// README API 文件名
public static final String README_FILE_NAME = "README.md";
// README_API 文件名
public static final String README_API_FILE_NAME = "README_API.md";
// ==========
// = DevApp =
// ==========
// DevApp API 文件保存路径
public static final String DEV_APP_API_FILE_SAVE_PATH = FILE_SAVE_PATH + "DevApp/";
// DevApp 文件路径
public static final String DEV_APP_PATH = LOCAL_PATH + "/DevUtils/lib/DevApp/src/main/java/dev/";
// DevApp Utils 文件路径
public static final String DEV_APP_UTILS_PATH = DEV_APP_PATH + "utils/";
// DevApp GitHub 项目文件路径
public static final String DEV_APP_GITHUB_URL = GITHUB_AUTHOR_URL + "/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/";
// DevApp 版本号
public static final String DEV_APP_VERSION = "2.0.8";
// ===========
// = DevJava =
// ===========
// DevJava API 文件保存路径
public static final String DEV_JAVA_API_FILE_SAVE_PATH = FILE_SAVE_PATH + "DevJava/";
// DevJava 文件路径
public static final String DEV_JAVA_PATH = LOCAL_PATH + "/DevUtils/lib/DevJava/src/main/java/dev/";
// DevJava Utils 文件路径
public static final String DEV_JAVA_UTILS_PATH = DEV_JAVA_PATH + "utils/";
// DevJava GitHub 项目文件路径
public static final String DEV_JAVA_GITHUB_URL = GITHUB_AUTHOR_URL + "/DevUtils/blob/master/lib/DevJava/src/main/java/dev/utils/";
// DevJava 版本号
public static final String DEV_JAVA_VERSION = "1.2.1";
// =============
// = DevAssist =
// =============
// 包目录名
public static final String DEV_ASSIST_PACKAGE = "dev";
// DevAssist API 文件保存路径
public static final String DEV_ASSIST_API_FILE_SAVE_PATH = FILE_SAVE_PATH + "DevAssist/";
// DevAssist 文件路径
public static final String DEV_ASSIST_PATH = LOCAL_PATH + "/DevUtils/lib/DevAssist/src/main/java/dev/";
// DevAssist GitHub 项目文件路径
public static final String DEV_ASSIST_GITHUB_URL = GITHUB_AUTHOR_URL + "/DevUtils/blob/master/lib/DevAssist/src/main/java/dev";
// DevAssist 版本号
public static final String DEV_ASSIST_VERSION = "1.0.4";
// ============
// = DevOther =
// ============
// 包目录名
public static final String DEV_OTHER_PACKAGE = "dev";
// DevOther API 文件保存路径
public static final String DEV_OTHER_API_FILE_SAVE_PATH = FILE_SAVE_PATH + "DevOther/";
// DevOther 文件路径
public static final String DEV_OTHER_PATH = LOCAL_PATH + "/DevUtils/lib/DevOther/src/main/java/dev/";
// DevOther GitHub 项目文件路径
public static final String DEV_OTHER_GITHUB_URL = GITHUB_AUTHOR_URL + "/DevUtils/blob/master/lib/DevOther/src/main/java/dev";
// =============
// = DevWidget =
// =============
// 包目录名
public static final String DEV_WIDGET_PACKAGE = "dev";
// DevWidget API 文件保存路径
public static final String DEV_WIDGET_API_FILE_SAVE_PATH = FILE_SAVE_PATH + "DevWidget/";
// DevWidget 文件路径
public static final String DEV_WIDGET_PATH = LOCAL_PATH + "/DevUtils/lib/DevWidget/src/main/java/dev/";
// DevWidget GitHub 项目文件路径
public static final String DEV_WIDGET_GITHUB_URL = GITHUB_AUTHOR_URL + "/DevUtils/blob/master/lib/DevWidget/src/main/java/dev";
// DevWidget 版本号
public static final String DEV_WIDGET_VERSION = "1.0.4";
// ===========
// = DevBase =
// ===========
// 包目录名
public static final String DEV_BASE_PACKAGE = "dev.base";
// DevBase API 文件保存路径
public static final String DEV_BASE_API_FILE_SAVE_PATH = FILE_SAVE_PATH + "DevBase/";
// DevBase 文件路径
public static final String DEV_BASE_PATH = LOCAL_PATH + "/DevUtils/lib/DevBase/src/main/java/dev/base/";
// DevBase GitHub 项目文件路径
public static final String DEV_BASE_GITHUB_URL = GITHUB_AUTHOR_URL + "/DevUtils/blob/master/lib/DevBase/src/main/java/dev/base";
// DevBase 版本号
public static final String DEV_BASE_VERSION = "1.0.0";
// ===============
// = DevBaseMVVM =
// ===============
// 包目录名
public static final String DEV_BASE_MVVM_PACKAGE = "dev.base";
// DevBaseMVVM API 文件保存路径
public static final String DEV_BASE_MVVM_API_FILE_SAVE_PATH = FILE_SAVE_PATH + "DevBaseMVVM/";
// DevBaseMVVM 文件路径
public static final String DEV_BASE_MVVM_PATH = LOCAL_PATH + "/DevUtils/lib/DevBaseMVVM/src/main/java/dev/base/";
// DevBaseMVVM GitHub 项目文件路径
public static final String DEV_BASE_MVVM_GITHUB_URL = GITHUB_AUTHOR_URL + "/DevUtils/blob/master/lib/DevBaseMVVM/src/main/java/dev/base";
// DevBaseMVVM 版本号
public static final String DEV_BASE_MVVM_VERSION = "1.0.0";
// ===============
// = DevStandard =
// ===============
// 包目录名
public static final String DEV_STANDARD_PACKAGE = "dev";
// DevStandard API 文件保存路径
public static final String DEV_STANDARD_API_FILE_SAVE_PATH = FILE_SAVE_PATH + "DevStandard/";
// DevStandard 文件路径
public static final String DEV_STANDARD_PATH = LOCAL_PATH + "/DevUtils/lib/DevStandard/src/main/java/dev/";
// DevStandard GitHub 项目文件路径
public static final String DEV_STANDARD_GITHUB_URL = GITHUB_AUTHOR_URL + "/DevUtils/blob/master/lib/DevStandard/src/main/java/dev";
// =======
// = 其他 =
// =======
// 方法名规则
public static final String sMethodNameRegex = "[A-Za-z]+[2][A-Za-z][A-Za-z0-9]+";
// ==================
// = DevApp、DevJava =
// ==================
// 包名目录注释
public static final HashMap<String, String> sCatalogMap = new HashMap<>();
// 忽略不保存的类
public static final HashMap<String, String> sFilterClassMap = new HashMap<>();
// 忽略不保存的方法
public static final HashMap<String, String[]> sFilterMethodMap = new HashMap<>();
// =============
// = DevAssist =
// =============
// 包名目录注释
public static final HashMap<String, String> sCatalogMap_Assist = new HashMap<>();
// 忽略不保存的类
public static final HashMap<String, String> sFilterClassMap_Assist = new HashMap<>();
// 忽略不保存的方法
public static final HashMap<String, String[]> sFilterMethodMap_Assist = new HashMap<>();
// ============
// = DevOther =
// ============
// 包名目录注释
public static final HashMap<String, String> sCatalogMap_Other = new HashMap<>();
// 忽略不保存的类
public static final HashMap<String, String> sFilterClassMap_Other = new HashMap<>();
// 忽略不保存的方法
public static final HashMap<String, String[]> sFilterMethodMap_Other = new HashMap<>();
// ============
// = DevOther =
// ============
// 包名目录注释
public static final HashMap<String, String> sCatalogMap_Base = new HashMap<>();
// =============
// = DevWidget =
// =============
// 包名目录注释
public static final HashMap<String, String> sCatalogMap_Widget = new HashMap<>();
// 忽略不保存的类
public static final HashMap<String, String> sFilterClassMap_Widget = new HashMap<>();
// 忽略不保存的方法
public static final HashMap<String, String[]> sFilterMethodMap_Widget = new HashMap<>();
static {
// 初始化 包名目录注释 Map
initCatalogMap();
// 初始化 忽略不保存的类 Map
initFilterClassMap();
// 初始化 忽略不保存的方法 Map
initFilterMethodMap();
// 初始化方法名正则表达式
initMethodNameRegex();
}
// ===============
// = 内部初始化方法 =
// ===============
/**
* 初始化 包名目录注释 Map
*/
private static void initCatalogMap() {
// ==================
// = DevApp、DevJava =
// ==================
sCatalogMap.put("dev.utils", "根目录");
// ===========
// = APP 目录 =
// ===========
sCatalogMap.put(".app", "APP 相关工具类");
sCatalogMap.put(".app.anim", "动画工具类");
sCatalogMap.put(".app.assist", "辅助类");
sCatalogMap.put(".app.assist.manager", "管理器 如: TimerManager");
sCatalogMap.put(".app.cache", "缓存工具类");
sCatalogMap.put(".app.camera1", "摄像头相关 android.hardware.Camera");
sCatalogMap.put(".app.helper", "功能 Helper 辅助类");
sCatalogMap.put(".app.image", "图片相关处理");
sCatalogMap.put(".app.info", "APP 信息、PackageInfo 等");
sCatalogMap.put(".app.logger", "日志库 DevLogger");
sCatalogMap.put(".app.permission", "权限工具类");
sCatalogMap.put(".app.player", "多媒体 ( 视频、音频 ) 播放封装");
sCatalogMap.put(".app.share", "SharedPreferences 封装");
sCatalogMap.put(".app.toast", "Toast");
sCatalogMap.put(".app.toast.toaster", "Toaster 处理无通知权限");
sCatalogMap.put(".app.wifi", "Wifi、热点工具类");
// ==============
// = Common 目录 =
// ==============
sCatalogMap.put(".common", "Java 工具类, 不依赖 android api");
sCatalogMap.put(".common.assist", "各种快捷辅助类");
sCatalogMap.put(".common.assist.search", "搜索相关 ( 文件搜索等 )");
sCatalogMap.put(".common.cipher", "编 / 解码工具类");
sCatalogMap.put(".common.encrypt", "加密工具类");
sCatalogMap.put(".common.file", "文件分片相关");
sCatalogMap.put(".common.random", "随机概率算法工具类");
sCatalogMap.put(".common.thread", "线程相关");
sCatalogMap.put(".common.validator", "数据校验工具类");
// =============
// = DevAssist =
// =============
sCatalogMap_Assist.put("dev", "根目录");
sCatalogMap_Assist.put(".assist", "快捷功能辅助类");
sCatalogMap_Assist.put(".assist.adapter", "Adapter 相关");
sCatalogMap_Assist.put(".assist.multiselect", "多选模块");
sCatalogMap_Assist.put(".assist.multiselect.edit", "多选编辑方法");
sCatalogMap_Assist.put(".base", "基类相关");
sCatalogMap_Assist.put(".callback", "回调相关");
sCatalogMap_Assist.put(".callback.click", "点击回调");
sCatalogMap_Assist.put(".callback.common", "通用回调");
sCatalogMap_Assist.put(".callback.result", "操作结果回调");
sCatalogMap_Assist.put(".engine", "兼容 Engine");
sCatalogMap_Assist.put(".engine.http", "Http Engine");
sCatalogMap_Assist.put(".engine.image", "Image Engine");
sCatalogMap_Assist.put(".engine.json", "JSON Engine");
sCatalogMap_Assist.put(".engine.log", "Log Engine");
// ============
// = DevOther =
// ============
sCatalogMap_Other.put("dev", "根目录");
sCatalogMap_Other.put(".assist", "常用辅助类封装");
sCatalogMap_Other.put(".other", "第三方库封装工具类");
sCatalogMap_Other.put(".other.okgo", "OkGo 网络请求");
sCatalogMap_Other.put(".other.picture", "PictureSelector 图片选择库");
sCatalogMap_Other.put(".other.retrofit", "Retrofit 网络请求");
sCatalogMap_Other.put(".other.retrofit.response", "请求响应解析");
sCatalogMap_Other.put(".other.retrofit.subscriber", "请求响应处理");
sCatalogMap_Other.put(".receiver", "BroadcastReceiver 监听相关");
sCatalogMap_Other.put(".service", "Service 相关");
sCatalogMap_Other.put(".temp", "临时快捷调用工具类");
// =============
// = DevWidget =
// =============
sCatalogMap_Widget.put("dev", "根目录");
sCatalogMap_Widget.put(".widget", "自定义 View 根目录");
sCatalogMap_Widget.put(".widget.adjust", "自动调节高度 View");
sCatalogMap_Widget.put(".widget.assist", "View 辅助类");
sCatalogMap_Widget.put(".widget.custom", "自定义 View");
sCatalogMap_Widget.put(".widget.function", "需求功能 View");
sCatalogMap_Widget.put(".widget.ui", "UI View");
sCatalogMap_Widget.put(".widget.utils", "工具类目录");
// ===========
// = DevBase =
// ===========
sCatalogMap_Base.put("dev.base", "根目录");
sCatalogMap_Base.put(".able", "基类库接口相关");
sCatalogMap_Base.put(".activity", "核心 Base Activity 代码");
sCatalogMap_Base.put(".expand", "基于 Base Activity、Fragment 扩展包");
sCatalogMap_Base.put(".expand.content", "Content Layout 基类");
sCatalogMap_Base.put(".expand.mvp", "MVP 架构基类");
sCatalogMap_Base.put(".expand.viewbinding", "ViewBinding 基类");
sCatalogMap_Base.put(".fragment", "核心 Base Fragment 代码");
sCatalogMap_Base.put(".utils", "依赖工具包");
sCatalogMap_Base.put(".utils.assist", "功能辅助类 ( 抽取通用代码 )");
}
/**
* 初始化 忽略不保存的类 Map
*/
private static void initFilterClassMap() {
// ==================
// = DevApp、DevJava =
// ==================
// =======
// = APP =
// =======
sFilterClassMap.put("IPrinter.java", "");
sFilterClassMap.put("IPreference.java", "");
sFilterClassMap.put("IToast.java", "");
sFilterClassMap.put("DefaultToastStyle.java", "");
sFilterClassMap.put("WifiVo.java", "");
// ==========
// = Common =
// ==========
sFilterClassMap.put("Cipher.java", "");
sFilterClassMap.put("Decrypt.java", "");
sFilterClassMap.put("Encrypt.java", "");
// =============
// = DevAssist =
// =============
}
/**
* 初始化 忽略不保存的方法 Map
*/
private static void initFilterMethodMap() {
// ==================
// = DevApp、DevJava =
// ==================
// =======
// = APP =
// =======
sFilterMethodMap.put("ActivityUtils.java", new String[]{"onStartActivityForResult", "onActivityResult", "start", "onCreate", "onDestroy"});
sFilterMethodMap.put("PermissionUtils.java", new String[]{"start", "onCreate", "onGranted", "onDenied"});
sFilterMethodMap.put("WifiHotUtils.java", new String[]{"onStarted", "onStopped", "onFailed"});
sFilterMethodMap.put("HandlerUtils.java", new String[]{"onEnd"});
sFilterMethodMap.put("OnLocationChangeListener.java", new String[]{"getLastKnownLocation", "onLocationChanged", "onStatusChanged"});
sFilterMethodMap.put("SizeUtils.java", new String[]{"onGetSize"});
sFilterMethodMap.put("KeyBoardUtils.java", new String[]{"onSoftInputChanged"});
sFilterMethodMap.put("DevMediaManager.java", new String[]{"onPrepared", "onCompletion", "onBufferingUpdate", "onSeekComplete", "onError", "onVideoSizeChanged", "isLooping", "setMediaConfig"});
sFilterMethodMap.put("DevVideoPlayerControl.java", new String[]{"onPrepared", "onCompletion", "onBufferingUpdate", "onSeekComplete", "onError", "onVideoSizeChanged", "isLooping", "setMediaConfig", "surfaceChanged", "surfaceCreated", "surfaceDestroyed"});
sFilterMethodMap.put("CameraAssist.java", new String[]{"stopPreviewNotify", "startPreviewNotify"});
sFilterMethodMap.put("ImageUtils.java", new String[]{"getValue"});
sFilterMethodMap.put("ToastUtils.java", new String[]{"filter", "handlerContent"});
sFilterMethodMap.put("AnalysisRecordUtils.java", new String[]{"callback"});
sFilterMethodMap.put("AsyncExecutor.java", new String[]{"doInBackground", "onPostExecute", "onCanceled", "abort"});
sFilterMethodMap.put("ToastTintUtils.java", new String[]{"getTextColor", "getTextSize", "getBackgroundTintColor", "getBackground", "getMaxLines", "getEllipsize", "getTypeface", "getTintIconColor", "isTintIcon", "filter", "handlerContent"});
sFilterMethodMap.put("EditTextUtils.java", new String[]{"getMarkId", "isOperate", "setOperate", "getOperateState", "setOperateState", "getType", "setType", "beforeTextChanged", "onTextChanged", "afterTextChanged"});
sFilterMethodMap.put("AutoFocusAssist.java", new String[]{"onAutoFocus"});
sFilterMethodMap.put("PhoneUtils.java", new String[]{"printInfo"});
sFilterMethodMap.put("ROMUtils.java", new String[]{"getName", "getVersion", "toString"});
sFilterMethodMap.put("DialogUtils.java", new String[]{"onLeftButton", "onRightButton", "onDismiss", "onSingleChoiceItems", "onPositiveButton", "onCancel", "onMultiChoiceItems"});
sFilterMethodMap.put("SnackbarUtils.java", new String[]{"getRootGravity", "setRootGravity", "getRootCornerRadius", "setRootCornerRadius", "getRootBackgroundTintColor", "setRootBackgroundTintColor", "getRootBackground", "setRootBackground", "getRootMargin", "setRootMargin", "getRootAlpha", "setRootAlpha", "getTextGravity", "setTextGravity", "getTextColor", "setTextColor", "getTextSize", "setTextSize", "getTextMaxLines", "setTextMaxLines", "getTextEllipsize", "setTextEllipsize", "getTextTypeface", "setTextTypeface", "getTextPadding", "setTextPadding", "getActionGravity", "setActionGravity", "getActionColor", "setActionColor", "getActionSize", "setActionSize", "getActionPadding", "setActionPadding", "getActionCornerRadius", "setActionCornerRadius", "getActionBackgroundTintColor", "setActionBackgroundTintColor", "getActionBackground", "setActionBackground"});
sFilterMethodMap.put("ClickUtils.java", new String[]{"onClick", "doClick", "doInvalidClick", "getCount", "getInvalidCount", "getInvalidCycleNumber"});
sFilterMethodMap.put("ScreenshotUtils.java", new String[]{"onScreenshot", "onChange", "onChecker"});
// ==========
// = Common =
// ==========
sFilterMethodMap.put("FileBreadthFirstSearchUtils.java", new String[]{"isHandlerFile", "isAddToList", "OnEndListener"});
sFilterMethodMap.put("FileDepthFirstSearchUtils.java", new String[]{"isHandlerFile", "isAddToList", "OnEndListener"});
sFilterMethodMap.put("FileUtils.java", new String[]{"onReplace", "getSubFiles"});
sFilterMethodMap.put("FileRecordUtils.java", new String[]{"callback"});
sFilterMethodMap.put("HttpURLConnectionUtils.java", new String[]{"onResponse", "onFail"});
sFilterMethodMap.put("TimeKeeper.java", new String[]{"onEnd"});
sFilterMethodMap.put("TypeUtils.java", new String[]{"getActualTypeArguments", "getOwnerType", "getRawType", "equals", "hashCode"});
sFilterMethodMap.put("CollectionUtils.java", new String[]{"put", "create"});
sFilterMethodMap.put("ScaleUtils.java", new String[]{"getXYx", "getXY", "compareTo"});
sFilterMethodMap.put("ColorUtils.java", new String[]{"toString"});
sFilterMethodMap.put("KeyValueBean.java", new String[]{"toString"});
sFilterMethodMap.put("CalendarUtils.java", new String[]{"compareTo", "toString", "hook"});
// =============
// = DevAssist =
// =============
sFilterMethodMap_Assist.put("EditTextWatcherAssist.java", new String[]{"onTextChanged"});
sFilterMethodMap_Assist.put("NumberControlAssist.java", new String[]{"onPrepareChanged", "onNumberChanged"});
// =============
// = DevWidget =
// =============
sFilterMethodMap_Widget.put("ViewAssist.java", new String[]{"onRemove", "onNotFound", "onChange", "onCreateView", "onBindView"});
sFilterMethodMap_Widget.put("StateLayout.java", new String[]{"onRemove", "onNotFound", "onChange", "onCreateView", "onBindView"});
}
/**
* 初始化方法名正则表达式
*/
private static void initMethodNameRegex() {
// // 中间包含数字 2
// sMethodNameRegex = ".*2+.*";
// // 属于 xxx数字xxx
// sMethodNameRegex = "[A-Za-z]+[0-9][A-Za-z]+";
// // 属于 xxx2(xxx数字)
// sMethodNameRegex = "[A-Za-z]+[2][A-Za-z0-9]+";
// // 属于 xxx2x xx数字
// sMethodNameRegex = "[A-Za-z]+[2][A-Za-z][A-Za-z0-9]+";
}
}