[MRESOLVER-53] Document runtime exceptions

• Type: Wish
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: Maven Artifact Resolver 1.1.1
• Fix Version/s: 1.3.3
• Component/s: Resolver
• Labels: up-for-grabs
• Assignee: Olivier Lamy
• Reporter: Elliotte Rusty Harold
• Created: 06/Aug/18 14:14
• Updated: 09/Mar/19 16:59
• Resolved: 09/Mar/19 16:59

Description

The API documentation should specify which runtime exceptions are thrown when and why. For instance, DefaultArtifact's constructors seem to throw IllegalArgumentExceptions if given bad coordinates:

Exception in thread "main" java.lang.IllegalArgumentException: Bad artifact coordinates blah blah, expected format is <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>

That's reasonable. However it's not mentioned in the Javadoc, and I'm about to commit code to my project that depends on this behavior. We should document and commit to these.