Please definitely list all such possible exceptions. The knowledge outweighs concern for clutter, IMO. I'd rather know the full number of ways an API can fail rather than receive a failure that wasn't documented.
Cheers, Paul On Thu, Jun 16, 2016 at 11:44 AM, Alan Bateman <alan.bate...@oracle.com> wrote: > On 16/06/2016 17:31, Mandy Chung wrote: > > : >> ModuleFinder.of spec describes the possible cases where FindException may >> be thrown by a module finder’s find or findAll methods. >> >> It would be useful to have the @throws FindException if an error occurs >> finding all modules in find and findAll methods to link to such description. >> > My concern with this is that it will clutter the @throws description if we > attempt to link to all cases (there are too many). > > >> As I commented offline, it’d be good to link to the definition of legal >> package name but looks like we need to add that in some appropriate spec >> before we can do that. >> >> There is big overhaul of the builder API needed and I think that is the > right place to do this. The javadoc update here deliberately delegates to > avoid repeating everything. > > -Alan >
