Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit b061883

Browse files
docs(readme): fix all
1 parent fb3f704 commit b061883

File tree

1 file changed

+91
-1
lines changed

1 file changed

+91
-1
lines changed

‎README.md

Lines changed: 91 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,100 @@ repositories {
99
}
1010

1111
dependencies {
12-
implementation("com.github.merge-simpson:letsdev-error-code-api:0.1.0") // added
12+
implementation("com.github.merge-simpson:letsdev-error-code-api:0.2.0") // added
1313
}
1414
```
1515

1616
# Features
1717

18+
## Pure Java Error Code
19+
20+
- `BaseErrorCode` `<<interface>>`
21+
- `BaseCustomException` `<<exception>>`
22+
23+
```mermaid
24+
%%{init: {"theme": "forest", "themeVariables": {"fontFamily": "Comic Sans MS"}}}%%
25+
classDiagram
26+
%% 클래스 목록
27+
class BaseErrorCode {
28+
<<interface>>
29+
+name() String
30+
+message() String
31+
+statusCode() int
32+
+exception() RuntimeException
33+
+exception(Throwable cause) RuntimeException
34+
+exception(Runnable action) RuntimeException
35+
+exception(Runnable action, Throwable cause) RuntimeException
36+
+exception(Supplier&lt;Map&lt;String,Object>> payloadSupplier) RuntimeException
37+
+exception(Supplier&lt;Map&lt;String,Object>> payloadSupplier, Throwable cause) RuntimeException
38+
}
39+
40+
class BaseCustomException {
41+
#errorCode: BaseErrorCode
42+
#action: Runnable
43+
#payloadSupplier: Supplier&lt;Map&lt;String,Object>>
44+
45+
+BaseCustomException()
46+
+BaseCustomException(message: String)
47+
+BaseCustomException(message: String, cause: Throwable)
48+
+BaseCustomException(errorCode: BaseErrorCode)
49+
+BaseCustomException(errorCode: BaseErrorCode, cause: Throwable)
50+
+BaseCustomException(errorCode: BaseErrorCode, action: Runnable)
51+
+BaseCustomException(errorCode: BaseErrorCode, action: Runnable, cause: Throwable)
52+
+BaseCustomException(errorCode: BaseErrorCode, payloadSupplier: Supplier&lt;Map&lt;String,Object>>)
53+
+BaseCustomException(errorCode: BaseErrorCode, payloadSupplier: Supplier&lt;Map&lt;String,Object>>, cause: Throwable)
54+
55+
+getErrorCode() : BaseErrorCode
56+
-(static) getDefaultErrorCode() : BaseErrorCode
57+
}
58+
59+
class DefaultBaseErrorCodeHolder {
60+
<<private>>
61+
-INSTANCE : BaseErrorCode
62+
}
63+
64+
%% 관계 표현
65+
BaseCustomException ..> BaseErrorCode : uses
66+
BaseCustomException o-- DefaultBaseErrorCodeHolder : contains
67+
```
68+
69+
## Spring-Dependent Error Code
70+
71+
- `ErrorCode`: `<<interface>>`
72+
- `CustomException` `<<exception>>`
73+
74+
**Usage**
75+
76+
```mermaid
77+
%%{init: {"theme": "forest", "themeVariables": {"fontFamily": "Comic Sans MS"}}}%%
78+
classDiagram
79+
%% 클래스 목록
80+
class BaseErrorCode {
81+
<<interface>>
82+
}
83+
84+
class BaseCustomException {
85+
<<exception>>
86+
}
87+
88+
class ErrorCode {
89+
<<interface>>
90+
+httpStatus() HttpStatus
91+
}
92+
93+
class CustomException {
94+
<<exception>>
95+
}
96+
97+
%% 관계 표현
98+
%% ErrorCode ..|> BaseErrorCode
99+
%% CustomException --|> BaseCustomException
100+
BaseCustomException ..> BaseErrorCode : uses
101+
CustomException ..> ErrorCode : uses
102+
```
103+
104+
<!--
105+
18106
## 확장 가능한 Error Code
19107
20108
- \<\<interface\>\> `ErrorCode` (Spring-dependent)
@@ -61,3 +149,5 @@ public final class GlobalExceptionHandler {
61149
| Group | Artifact ID |
62150
|:-------------------:|:-----------:|
63151
| org.springframework | spring-web |
152+
153+
-->

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /