Skip to content

Commit 3306668

Browse files
committed
Update README.md
1 parent a2df671 commit 3306668

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,18 @@
44

55
This small library holds a set of Exceptions that implements idea of fast, reusable, error codes that can be simple thrown fast in case of unpredictable and unrecoverable application failure.
66

7-
## Caution
7+
## Idea
88

9-
This classes shouldn't be used in any public API or library. It is designed to be used for in-house development of end user applications which will report Bugs in standardized error pages or post them to issue tracker.
9+
The idea is to have a set of simple runtime exceptions. They should always take the field Exception ID (Eid) in the making. This field will then be reported when displaying or logging that exception. It can also be viewed on the professional fatal error window of the application as a bug reference. This approach simplifies the management of exceptions in the application and allows developers to focus on functionalities rather than coming up with the correct statement for the exception.
1010

11-
## Requirements
11+
This approach is best to use with tools and plugins like:
1212

13-
* JDK >= 1.6
13+
* [EidGenerator for Netbeans IDE](http://plugins.netbeans.org/plugin/53137/exception-id-eid-generator)
14+
* [Generating Exception Id number in Intellij IDEA with Live Templates](https://github.com/wavesoftware/java-eid-exceptions/wiki/Generating%20Exception%20Id%20number%20in%20Intellij%20IDEA%20with%20Live%20Templates)
15+
16+
## Caution
17+
18+
This classes shouldn't be used in any public API or library. It is designed to be used for in-house development of end user applications which will report bugs in standardized error pages or post them to issue tracker.
1419

1520
## Maven
1621

@@ -30,8 +35,6 @@ Static convenience methods that help a method or constructor check whether it wa
3035

3136
Each method accepts a EID string or Eid object, which is designed to ease of use and provide strict ID for given exception usage. This approach speed up development of large application and helps support teams by giving both static and random ID for each possible unpredicted bug.
3237

33-
This approach is best to use with tools and plugins like [EidGenerator for Netbeans IDE](http://plugins.netbeans.org/plugin/53137/exception-id-eid-generator)
34-
3538
Example:
3639

3740
```java
@@ -97,6 +100,10 @@ To contribute, follow the standard [git flow](http://danielkummer.github.io/git-
97100

98101
Even if you can't contribute code, if you have an idea for an improvement please open an [issue](https://github.com/wavesoftware/java-eid-exceptions/issues).
99102

103+
## Requirements
104+
105+
* JDK >= 1.6
106+
100107
### Releases
101108

102109
- 1.0.0

0 commit comments

Comments
 (0)