This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 209251 - Undocumented magic keys passed to JPDADebugger.startListening
Summary: Undocumented magic keys passed to JPDADebugger.startListening
Status: RESOLVED FIXED
Alias: None
Product: debugger
Classification: Unclassified
Component: Java (show other bugs)
Version: 7.2
Hardware: All All
: P3 normal (vote)
Assignee: Martin Entlicher
URL:
Keywords: API
Depends on:
Blocks: 201754
  Show dependency tree
 
Reported: 2012-03-06 22:13 UTC by Jesse Glick
Modified: 2012-06-15 06:10 UTC (History)
0 users

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jesse Glick 2012-03-06 22:13:36 UTC
JPDADebugger.startListening takes an Object[] services with no further documentation as to what this might be. From grepping sources starting at maven.debug.JPDAStart or debugger.jpda.ant.JPDAStart you can find that SourcePathProviderImpl expects a Map<String,Object> and that e.g. "sourcepath" should be set to a ClassPath object of some sort.

This does not appear to be documented anywhere. I would expect the startListening Javadoc (or some Javadoc it links to) to specify particular services it expects, and for the Map<String,Object> to have a list of expected Java constants (used by both SPPI and all known clients), each of which would have Javadoc explaining what type its value should be and how that value is to be interpreted.
Comment 1 Martin Entlicher 2012-06-13 16:04:33 UTC
Fixed by changeset:   224380:bb3716818a5a
http://hg.netbeans.org/main/rev/bb3716818a5a
Comment 2 Quality Engineering 2012-06-15 06:10:46 UTC
Integrated into 'main-golden', will be available in build *201206150001* on http://bits.netbeans.org/dev/nightly/ (upload may still be in progress)
Changeset: http://hg.netbeans.org/main-golden/rev/bb3716818a5a
User: mentlicher@netbeans.org
Log: #209251: Description of Object[] services argument is added.