jsr-333
  1. jsr-333
  2. JSR_333-71

mistakes in javadoc for Node#getNodes and Event#getMixinNodeTypes ?

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      while working on JSR_333-59 i noticed two confusing things:

      Node#getNodes(String[] nameGlobs, String[] typeGlobs)

      how would typeGlobs work exactly? its not really globs, right? the doc says we do Node.isNodeType(T) but that method does not accept globs. i guess that second parameter is simple typeNames, right?

      Event#getMixinNodeTypes (and also getPrimaryNodeType) do not list the PROPERTY_CHANGED event as being able to return this information. is this on purpose or an accident? if its on purpose, i propose to add something explaining why it should not work.

        Activity

        dbu created issue -
        Hide
        Peeter Piegaze added a comment -

        You are right about the Event#getMixinTypes and Event#getPrimaryNodeType. They should both include explanations of what is returned when this Event is PROPERTY_CHANGED. I have fixed the javadoc.

        Regarding the typeGlobs issue: For an accessible node N to be returned, the typeGlob string is required to match T where T is the name of a type that applies to N, and the nameGlob string is required to match C, where C is the name of N.

        By "match" we mean "match by globbing", not "is equal to". I will clarify the language in the javadoc.

        Show
        Peeter Piegaze added a comment - You are right about the Event#getMixinTypes and Event#getPrimaryNodeType. They should both include explanations of what is returned when this Event is PROPERTY_CHANGED. I have fixed the javadoc. Regarding the typeGlobs issue: For an accessible node N to be returned, the typeGlob string is required to match T where T is the name of a type that applies to N, and the nameGlob string is required to match C, where C is the name of N. By "match" we mean "match by globbing", not "is equal to". I will clarify the language in the javadoc.
        Hide
        Peeter Piegaze added a comment -

        fixed

        Show
        Peeter Piegaze added a comment - fixed
        Peeter Piegaze made changes -
        Field Original Value New Value
        Status Open [ 1 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Hide
        dbu added a comment -
        Show
        dbu added a comment - added to PHPCR in https://github.com/phpcr/phpcr/pull/72

          People

          • Assignee:
            Unassigned
            Reporter:
            dbu
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: