Issue | Fix Version | Assignee | Priority | Status | Resolution | Resolved In Build |
---|---|---|---|---|---|---|
JDK-2083327 | 5.0 | Jeff Suttor | P4 | Resolved | Fixed | beta2 |
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)
======================================================================
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)
======================================================================
- backported by
-
JDK-2083327 XPathExpression doc. doesn't say that it represents a compiled XPath expression
-
- Resolved
-