search

msemys / esjc

EventStore Java Client
MIT License
108 stars 27 forks source link

Exception documentation #1

Closed michael-schnell closed 8 years ago

michael-schnell commented 8 years ago

It's hard to figure out what exceptions are thrown executing an operation. Currently the only way is to dive into the source code. It would be nice to add "@throws" javadoc to the AbstractEventStore or EventStore API. I know those are runtime exceptions but sometimes it's necessary to catch them and wrap them into other ones.

Background: I'm currently trying to create a wrapper for your stuff for the event-store-commons library. Your exceptions like 'WrongExpectedVersionException' have to be converted into the same named one in that library.

msemys commented 8 years ago

I'll try to enrich API documentation with client exceptions (when future completes exceptionally) for the next release.

michael-schnell commented 8 years ago

Cool.