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

XPathExpression doc. doesn't say that it represents a compiled XPath expression

    XMLWordPrintable

    Details

    • Type: Enhancement
    • Status: Resolved
    • Priority: P4
    • Resolution: Fixed
    • Affects Version/s: 5.0
    • Fix Version/s: 1.3.0
    • Component/s: xml
    • Subcomponent:
    • Resolved In Build:
      1.3
    • CPU:
      x86
    • OS:
      windows_xp

      Backports

        Description

        Name: rmT116609 Date: 05/13/2004


        A DESCRIPTION OF THE PROBLEM :
        The XPathExpression class description says that class "XPathExpression
        provides access to compiled XPath expressions."

        However, it never simply says that (one instance of ) XPathExpression
        _represents_ _a_ compiled XPath expression.

        Note that that omission makes further documentation harder to follow.
        Consider the description of the first evaluate(...) method:
         
           Evaluate[s] the compiled XPath expression in the specified context and
           return[s] the result as the specified type.

        The reader is lef t to wonder, "Which compiled XPath expression?" since
        no single XPath expression has been identified.



        EXPECTED VERSUS ACTUAL BEHAVIOR :
        EXPECTED -
        Since an instance of XPathExpression represents something (a compiled
        XPath expression), the documentation should probably say that directly.

        (Having only the "provides access to" wording would seem more appropriate
        for, say, an uninstantiatable utility class.)

        If the evalute(...) method's description is going to refer to "the ... expression,"
        some description needs to establish that there is some associated or
        identified expression.
        ACTUAL -
        See Description section.

        URL OF FAULTY DOCUMENTATION :
        http://java.sun.com/j2se/1.5.0/docs/api/javax/xml/xpath/XPathExpression.html
        (Incident Review ID: 265387)
        ======================================================================

          Attachments

            Issue Links

              Activity

                People

                Assignee:
                jsuttorsunw Jeff Suttor (Inactive)
                Reporter:
                rmandalasunw Ranjith Mandala (Inactive)
                Votes:
                0 Vote for this issue
                Watchers:
                0 Start watching this issue

                  Dates

                  Created:
                  Updated:
                  Resolved:
                  Imported:
                  Indexed: