Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: current
    • Fix Version/s: milestone 1
    • Component/s: javadoc/api
    • Labels:
      None
    • Environment:

      Operating System: All
      Platform: All

    • Issuezilla Id:
      774

      Description

      The JavaDoc for Literal#getLiteralValue() says:

      /**

      • Gets the value of the literal.
        *
      • @return the bind variable name; non-null
        */

      the @return description is probably a copy-paste left over and should be:

      "@return the value of the literal."

      Similarly the JavaDoc of the factory method for literal is also incorrect:

      /**

      • Evaluates to a literal value.
      • <p/>
      • The query is invalid if no value is bound to <code>literalValue</code>.
        *
      • @param literalValue the value
      • @return the operand; non-null
      • @throws InvalidQueryException if a particular validity test is possible
      • on this method, the implemention chooses to perform that test (and not
      • leave it until later, on {@link #createQuery}, and the parameters given
        * fail that test
        * @throws RepositoryException if the operation otherwise fails
        */
        public Literal literal(Value literalValue)
        throws InvalidQueryException, RepositoryException;


        I think it should rather be something like:

        /**
        * Evaluates to a literal value.
        *
        * @param literalValue the value
        * @return the literal; non-null
        * @throws InvalidQueryException if a particular validity test is possible
        * on this method, the implemention chooses to perform that test (and not
        * leave it until later, on {@link #createQuery}

        , and the parameter given

      • fails that test
      • @throws RepositoryException if the operation otherwise fails
        */
        public Literal literal(Value literalValue)
        throws InvalidQueryException, RepositoryException;

        Activity

        Hide
        Peeter Piegaze added a comment -

        Fixed

        Show
        Peeter Piegaze added a comment - Fixed

          People

          • Assignee:
            jsr-283-issues
            Reporter:
            mreutegg
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: