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

javax.transaction.xa.Xid constants reference obsolete method names

    XMLWordPrintable

    Details

    • Type: CSR
    • Status: Closed
    • Priority: P4
    • Resolution: Approved
    • Fix Version/s: 10
    • Component/s: core-libs
    • Labels:
      None
    • Subcomponent:
    • Compatibility Risk:
      minimal
    • Interface Kind:
      Java API

      Description

      Summary

      JTA 1.0.1B changed the method names of getGtrid and getBquai. Unfortunately the javadocs for the fields were not updated to reference the revised method names.

      Problem

      JTA 1.0.1B changed the method names of getGtrid and getBquai. Unfortunately the javadocs for the fields were not updated to reference the revised method names.

      Solution

      Update the Xid constant values to refer to the correct method names.

      The change below was reviewed and approved by the JTA specification lead

      Specification

       $ hg diff
      diff -r 74988518da9a src/java.sql/share/classes/javax/transaction/xa/Xid.java
      --- a/src/java.sql/share/classes/javax/transaction/xa/Xid.java  Tue Aug 01 15:59:07 2017 -0700
      +++ b/src/java.sql/share/classes/javax/transaction/xa/Xid.java  Fri Aug 04 14:01:14 2017 -0400
      @@ -38,12 +38,12 @@
       public interface Xid {
      
            /**
       -     * Maximum number of bytes returned by getGtrid.
       +     * Maximum number of bytes returned by {@link #getGlobalTransactionId }.
             */
      
       final static int MAXGTRIDSIZE = 64;
      
            /**
       -     * Maximum number of bytes returned by getBqual.
       +    * Maximum number of bytes returned by {@link #getBranchQualifier }.
             */
            final static int MAXBQUALSIZE = 64;

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              lancea Lance Andersen
              Reporter:
              lancea Lance Andersen
              Reviewed By:
              Joe Wang
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: