Re: [xwiki-devs] [xwiki-notifications] r25956 - in platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki: api doc
Hi Sergiu,
/** - * @return can current user restore this document from recycle bin + * Check if the current user has the right to restore the document. + * + * @return {@code true} if the current user can restore this document, {@code false} otherwise * @throws XWikiException if any error */ - public boolean canUndelete() throws XWikiException + public boolean canUndelete() {
This looks like a public API change. You have introduced a checkstyle error (unused @throws tag) which I fixed since the build was failing. Not sure if the change of the API is a big deal or not in this case. - Asiri
On 12/28/2009 10:06 AM, Asiri Rathnayake wrote:
Hi Sergiu,
/** - * @return can current user restore this document from recycle bin + * Check if the current user has the right to restore the document. + * + * @return {@code true} if the current user can restore this document, {@code false} otherwise * @throws XWikiException if any error */ - public boolean canUndelete() throws XWikiException + public boolean canUndelete() {
This looks like a public API change. You have introduced a checkstyle error (unused @throws tag) which I fixed since the build was failing.
Yep, I fixed it locally, but fell asleep before pushing the commit to the central server. Doing it now.
Not sure if the change of the API is a big deal or not in this case.
IMO, it isn't, it's almost a bugfix. Public APIs should never throw exceptions, since they will end up as ugly stacktraces in HTML. -- Sergiu Dumitriu http://purl.org/net/sergiu/
participants (2)
-
Asiri Rathnayake -
Sergiu Dumitriu