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

Implementation Specific Properties: change prefix, plus add existing properties

    XMLWordPrintable

    Details

    • Type: CSR
    • Status: Closed
    • Priority: P4
    • Resolution: Approved
    • Fix Version/s: 17
    • Component/s: xml
    • Labels:
      None
    • Subcomponent:
    • Compatibility Risk:
      minimal
    • Compatibility Risk Description:
      No compatiblity risk. This change adds new names to the existing properties while maintaining the functionality for the existing ones.
    • Interface Kind:
      System or security property
    • Scope:
      JDK

      Description

      Summary

      Changes the prefix in the Naming Convention to jdk.xml; Adds documentation for a few existing features and properties to the module summary.

      Problem

      The documentation for Implementation Specific Features and Properties defined a URL-style prefix, that is, http://www.oracle.com/xml/jaxp/properties/ for properties, and http://www.oracle.com/xml/jaxp/features/ for features. These prefixes are long and also dependent on domain names. A better prefix would have been jdk.xml that was already used for the properties added since JDK 9.

      As Implementation Specific Features and Properties are now documented in the module summary, a few existing properties need to be added to complete the project.

      Solution

      Change the prefix in the Naming Convention from http://www.oracle.com/xml/jaxp/properties/ and http://www.oracle.com/xml/jaxp/features/ to jdk.xml.

      Add documentation for a few existing properties to the module summary.

      Specification

      1. Prefix

        In section Naming Convention, change the prefix from http://www.oracle.com/xml/jaxp/properties/ for properties and http://www.oracle.com/xml/jaxp/features/ for features to jdk.xml.

      2. Add the followings to table Implementation Specific Properties

        cdataChunkSize -- definition copied from the original specification.

        extensionClassLoader -- definition copied from the original specification.

      3. Add table Implementation Specific Features with the following features

        enableExtensionFunctions -- definition copied from the original specification.

        overrideDefaultParser -- definition copied from the original specification. To match the style of enableExtensionFunctions above, in the Value column, changed a boolean to true or false and started the sentence with True instead of Setting it to true.

        resetSymbolTable -- definition copied from the original specification. To match the style of enableExtensionFunctions above, in the Value column, changed a boolean to true or false and started the sentence with True instead of Setting it to true.

      4. Notes for the tables

        Added links to the notes in Features and Properties tables as both tables share the same notes.

      5. DatatypeFactory Lookup Mechanism

        Added DatatypeFactory to the JAXP Lookup Mechanism. See the first row in table JAXP Factories.


      Spec: http://cr.openjdk.java.net/~joehw/jdk17/8265248/spec_01/java.xml/module-summary.html

      Attachment: 8265248_spec_01.zip


      Update 02: add column How to set the feature to table Processors

      Spec: http://cr.openjdk.java.net/~joehw/jdk17/8265248/spec_02/java.xml/module-summary.html

      Attachment: 8265248_spec_02.zip


      Update 03:

      1. Changed the alignment for column How to set properties and How to set Features in table Processors from center to left justified;

      2. Changed the title for the column Name in table Implementation Specific Properties and Implementation Specific Features to Full Name; Added @systemProperty tag to all but extensionClassLoader which does not have a corresponding System Property, that allows the properties to be added to the search index (try putting one, e.g. 'jdk.xml.entityExpansionLimit`, in the search box. The result shall show, leading to the property).

      3. Changed the javadoc for DatatypeFactory::newInstance to be exactly the same as other factories, such as DocumentBuilderFactory::newInstance, pointing to the Lookup Mechanism in the module summary.

      Spec: http://cr.openjdk.java.net/~joehw/jdk17/8265248/spec_03/java.xml/module-summary.html

      Attachment: 8265248_spec_03.zip


      Update 04

      Added a table Legacy Property Names with a list of legacy property names to indicate that the old names will continue to be supported.

      Spec: http://cr.openjdk.java.net/~joehw/jdk17/8265248/spec_04/java.xml/module-summary.html

      Attachment: 8265248_spec_04.zip


      Update 05

      Clarify that the new one takes precedence if both the new and legacy properties are set; Deprecate the legacy properties.

      Spec: http://cr.openjdk.java.net/~joehw/jdk17/8265248/spec_05/java.xml/module-summary.html

      Attachment: 8265248_spec_05.zip

        Attachments

        1. 8265248_spec_01.zip
          1.22 MB
        2. 8265248_spec_02.zip
          1.22 MB
        3. 8265248_spec_03.zip
          1.90 MB
        4. 8265248_spec_04.zip
          1.90 MB
        5. 8265248_spec_05.zip
          1.90 MB

          Issue Links

            Activity

              People

              Assignee:
              joehw Joe Wang
              Reporter:
              joehw Joe Wang
              Reviewed By:
              Lance Andersen, Roger Riggs
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: