You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
All messages follow the format: [Module-Prefix]-[identifier]: [message]
8
+
9
+
Module Prefix: `CUI_TOOLS`
10
+
11
+
This document catalogs all structured log messages used in the cui-java-tools module. Each message has a unique identifier within its severity level range and is documented with its component, template, and usage description.
12
+
13
+
== INFO Level (001-099)
14
+
15
+
[cols="1,1,2,2", options="header"]
16
+
|===
17
+
|ID |Component |Message |Description
18
+
|CUI_TOOLS-1 |IO |Unable to resolve '%s' from classpath |Logged when a resource cannot be resolved from the classpath. Parameter: resource path
19
+
|===
20
+
21
+
== WARN Level (100-199)
22
+
23
+
[cols="1,1,2,2", options="header"]
24
+
|===
25
+
|ID |Component |Message |Description
26
+
|CUI_TOOLS-100 |IO |Unable to resolve real path for '%s', due to '%s'. Returning absolutePath. |Logged when real path resolution fails and the system falls back to absolute path. Parameters: path, error message
27
+
|CUI_TOOLS-101 |IO |File or Directory %s is not accessible, reason: %s |Logged when a file or directory accessibility check fails. Parameters: path, reason (e.g., "Not Writable", "Not Existing", "Not a directory")
28
+
|CUI_TOOLS-102 |REFLECT |Reading from field '%s' with accessible='%s' and parameter='%s' could not complete |Logged when reflection-based field reading fails. Parameters: field, accessible flag, source object
29
+
|CUI_TOOLS-103 |REFLECT |Unable to determine wrapper type for '%s' |Logged when wrapper type determination fails for a primitive type. Parameter: type name
30
+
|CUI_TOOLS-104 |REFLECT |Unable to determine generic-type for '%s' |Logged when generic type extraction fails for a given type. Parameter: type
31
+
|===
32
+
33
+
== ERROR Level (200-299)
34
+
35
+
[cols="1,1,2,2", options="header"]
36
+
|===
37
+
|ID |Component |Message |Description
38
+
|CUI_TOOLS-200 |IO |Unable to compare path_a='%s' and path_b='%s' |Logged when path comparison via Files.isSameFile() fails due to IOException. Parameters: first path, second path
39
+
|CUI_TOOLS-201 |IO |Retrieving the current dir failed |Logged when retrieving the current directory fails during external file path resolution
40
+
|CUI_TOOLS-202 |PROPERTY |Failed to read property '%s' from bean of type '%s' |Logged when property reading via reflection fails. Parameters: property name, bean type
41
+
|CUI_TOOLS-203 |PROPERTY |Failed to write property '%s' to bean of type '%s' |Logged when property writing via reflection fails. Parameters: property name, bean type
4.**Documentation**: Ensure all changes are documented
77
+
2.**Documentation**: Ensure all changes are documented
95
78
- Update Javadoc for public APIs
96
79
- Update AsciiDoc documentation if necessary
97
80
98
-
5.**Documentation**: Update if changes affect APIs, features, or configuration
81
+
3.**Documentation**: Update if changes affect APIs, features, or configuration
99
82
100
-
6.**Commit Message**: Follow Git Commit Standards
83
+
4.**Commit Message**: Follow Git Commit Standards
101
84
102
85
### Quality Requirements
103
86
- New code requires appropriate test coverage
@@ -108,10 +91,9 @@ Execute in sequence before ANY commit:
108
91
## Build Commands Template
109
92
Common Maven commands for CUI projects:
110
93
- Build project: `./mvnw clean install`
111
-
- Build Single Module: `./mvnw clean install -pl <module-name>`
112
94
- Run tests: `./mvnw test`
113
95
- Run single test: `./mvnw test -Dtest=ClassName#methodName`
114
-
- Clean-Up Code: `./mvnw -Ppre-commit clean install -DskipTests` -> Check the console after running the command and fix all errors and warnings, verify until they are all corrected
96
+
- Clean-Up Code: `./mvnw -Ppre-commit clean install` -> Check the console after running the command and fix all errors and warnings, verify until they are all corrected
0 commit comments