Bug ID: JDK-8163008 Eliminate methods in the WorkArounds.java

JDK-8163008 : Eliminate methods in the WorkArounds.java

Type: Task
Component: tools
Sub-Component: javadoc(tool)
Affected Version: tbd_major

Priority: P3
Status: Open
Resolution: Unresolved
OS: generic
CPU: generic

Submitted: 2016-08-02
Updated: 2023-11-02

Versions (Unresolved/Resolved/Fixed)

The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.

Other
tbd_majorUnresolved

Related Reports

Relates :	JDK-8164395 - Model API should provide API isSynthetic/isMandated
Relates :	JDK-8163315 - Implement an API to identify an implicitly declared annotation (or declaration)

Sub Tasks

JDK-8163307 :	[Model API] Investigate and implement NewSerializedForm - Open
JDK-8163310 :	[Tree API] Investigate and implement jx.lang.model searchClass - Resolved
JDK-8163332 :	[Doclet API] address isVisible() and shouldDocument() - Resolved
JDK-8163386 :	[Doclet] address interfaceTypesOf - Resolved
JDK-8163388 :	[Doclet] address the method overriddenType - Resolved
JDK-8163389 :	[Model API] address the method searchClass - Closed
JDK-8163390 :	[Doclet] address getAbbreviatedPackageElement - Open
JDK-8163391 :	[Doclet] address getConstValue - Resolved
JDK-8163392 :	address searchClass in javax.lang.model APIs - Closed
JDK-8163393 :	[performance] address getElementToTreePath - Open
JDK-8163394 :	[performance] address getJavaFileObject - Open
JDK-8163395 :	[TBD] address doclint initialization and use - Resolved

Description

There are several methods parked in the WorkArounds.java on the doclet side.
These methods and implementations basically violate the cardinal dependency rule, that is the doclet should only rely on the public APIs provided by the Doclet, Compiler Tree APIs, and the JDK platform APIs. 

However, these methods allow the Standard Doclet to get inside the javac internals.

There are 5 categories of these "violations" or "issues"

A. the issue should be implemented as a public API javax.lang.model       [Model API]
B. the issue should be implemented as a public in Compiler Tree APIs     [Tree Api]
C. the issue should be implemented as a public API in the javadoc APIs   [Doclet API]
D. the issue should be addressed as a bug fix in javax.lang.model           [Model bug]
E. the issue should be addressed entirely within a doclet                          [Doclet]

Comments

http://hg.openjdk.java.net/jdk9/dev/langtools/file/a8dde57edb12/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/WorkArounds.java

02-08-2016