jms-spec
  1. jms-spec
  2. JMS_SPEC-114

Clarify javadoc descriptions of XAQueueConnection#createSession and XATopicSession#createSession

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.1
    • Fix Version/s: 2.0FD, 2.0
    • Labels:
      None

      Description

      In JMS 1.1 the javadoc description of Connection#createSession is "Creates an Session object...Returns: a Session object"
      http://docs.oracle.com/javaee/6/api/javax/jms/XAConnection.html#createSession%28boolean,%20int%29

      However the javadoc description of XAQueueConnection.html#createQueueSession is "Creates an XAQueueSession object...Returns: a newly created XAQueueSession"
      http://docs.oracle.com/javaee/6/api/javax/jms/XAQueueConnection.html#createQueueSession%28boolean,%20int%29

      and the javadoc description of XATopicConnection#createTopicSession is "Creates an XATopicSession object...Returns: a newly created XA topic session"
      http://docs.oracle.com/javaee/6/api/javax/jms/XATopicConnection.html#createTopicSession%28boolean,%20int%29

      The latter two descriptions are inconsistent with the return type. The fact that the first description is consistent with the return type confirms that this is a typo. They should be changed to be consistent with the return type declared in the method signature.

      XAQueueConnection.html#createQueueSession should "return a QueueSession" and

      XATopicConnection#createTopicSession should "return a TopicSession"

        Activity

        Show
        Nigel Deakin added a comment - Now corrected at http://jms-spec.java.net/2.0-SNAPSHOT/apidocs/javax/jms/XAQueueConnection.html#createQueueSession%28boolean,%20int%29 http://jms-spec.java.net/2.0-SNAPSHOT/apidocs/javax/jms/XATopicConnection.html#createTopicSession%28boolean,%20int%29

          People

          • Assignee:
            Nigel Deakin
            Reporter:
            Nigel Deakin
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: