XalanJ2
  1. XalanJ2
  2. XALANJ-2556

Inconsistent Javadoc comment and code for execute(TransformerImpl) in org.apache.xalan.templates.ElemFallback

    Details

    • Type: Bug Bug
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: 2.7.1, 2.7
    • Fix Version/s: None
    • Component/s: None
    • Security Level: No security risk; visible to anyone (Ordinary problems in Xalan projects. Anybody can view the issue.)
    • Labels:
    • Environment:
      Platform Independent

      Description

      The Javadoc comment below states that the parameter transformer is a "non-null reference to the the current transform-time state.":
      /**
      ...

      • @param transformer non-null reference to the the current transform-time state.
        ...
        */
        public void execute(TransformerImpl transformer) throws TransformerException
        However, the method does not check the parameter for "null". It executes normally without throwing any exception when called with a null transformer.

      Suggested Fixes:
      1. Add parameter check for "null"
      or
      2. Remove "non-null" from @param.

        Activity

        Hide
        Steven J. Hathaway added a comment -

        XALANJ-2556 JavaDoc Comments

        Related Files: Needs Confirmation – Identify needed comment changes

        templates/ElemApplyImport.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemApplyTemplates.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemApplyTemplates.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemAttribute.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemAttribute.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemAttributeSet.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemCallTemplate.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemChoose.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemComment.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemCopy.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemCopyOf.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemElement.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemElement.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemExtensionCall.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemExtensionCall.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemExtensionCall.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemFallback.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemFallback.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemForEach.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemForEach.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemIf.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemLiteralResult.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemMessage.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemNumber.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemNumber.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemNumber.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemNumber.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemNumber.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemNumber.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemParam.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemPI.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemTemplateElement.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemTemplateElement.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemTemplateElement.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemTemplateElement.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemTemplate.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemTextLiteral.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemUnknown.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemUnknown.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemUse.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemUse.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemUse.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemValueOf.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemVariable.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemVariable.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemVariablePsuedo.java: * @param transformer non-null reference to the the current transform-time state.
        templates/ElemWithParam.java: * @param transformer non-null reference to the the current transform-time state.

        Show
        Steven J. Hathaway added a comment - XALANJ-2556 JavaDoc Comments Related Files: Needs Confirmation – Identify needed comment changes templates/ElemApplyImport.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemApplyTemplates.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemApplyTemplates.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemAttribute.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemAttribute.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemAttributeSet.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemCallTemplate.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemChoose.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemComment.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemCopy.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemCopyOf.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemElement.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemElement.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemExtensionCall.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemExtensionCall.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemExtensionCall.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemFallback.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemFallback.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemForEach.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemForEach.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemIf.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemLiteralResult.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemMessage.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemNumber.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemNumber.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemNumber.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemNumber.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemNumber.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemNumber.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemParam.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemPI.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemTemplateElement.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemTemplateElement.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemTemplateElement.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemTemplateElement.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemTemplate.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemTextLiteral.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemUnknown.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemUnknown.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemUse.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemUse.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemUse.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemValueOf.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemVariable.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemVariable.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemVariablePsuedo.java: * @param transformer non-null reference to the the current transform-time state. templates/ElemWithParam.java: * @param transformer non-null reference to the the current transform-time state.
        Hide
        SHIN HWEI TAN added a comment - - edited

        The Javadoc comments reported above are only referring to "@param transformer non-null reference to the the current transform-time state." for the method execute(TransformerImpl) in the templates/ElemFallback.java file because the method is empty.

        Show
        SHIN HWEI TAN added a comment - - edited The Javadoc comments reported above are only referring to "@param transformer non-null reference to the the current transform-time state." for the method execute(TransformerImpl) in the templates/ElemFallback.java file because the method is empty.

          People

          • Assignee:
            Unassigned
            Reporter:
            SHIN HWEI TAN
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:

              Time Tracking

              Estimated:
              Original Estimate - 0.05h
              0.05h
              Remaining:
              Remaining Estimate - 0.05h
              0.05h
              Logged:
              Time Spent - Not Specified
              Not Specified

                Development