Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8344448

Improve API documentation for java.lang.classfile.constantpool

XMLWordPrintable

    • Icon: CSR CSR
    • Resolution: Approved
    • Icon: P4 P4
    • 24, 25
    • core-libs
    • None
    • behavioral
    • minimal
    • Documentation update has no compatibility risk.
    • Java API
    • SE

      Summary

      Massively improve the documentation of java.lang.classfile.constantpool package.

      Problem

      The java.lang.classfile.constantpool package is shipped with bare documentation. Additional documentation may help users to better understand the API model, the constant pool, and best practices.

      Solution

      1. Improve the package info to give an overview about the usage of pool entries in reading and writing, pool builders (including temporary pools) and the exception behaviors.
      2. For each pool entry, describe its conceptual/physical data model: this will be removed from the java.lang.classfile top level documentation later.
      3. Add notes to indicate how to get a symbolic representation, to discourage the use of raw constant pool entries.

      Specification

      See the attachments. Note that the latest revisions javadoc and apidiff are available in CR links.

            liach Chen Liang
            liach Chen Liang
            Adam Sotona
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: