Class Comment

    • Constructor Detail

      • Comment

        public Comment()
        Construct the instruction
    • Method Detail

      • getInstructionNameCode

        public int getInstructionNameCode()
        Get the instruction name, for diagnostics and tracing return the string "xsl:comment"
        Overrides:
        getInstructionNameCode in class Instruction
        Returns:
        a code identifying the instruction: typically but not always the fingerprint of a name in the XSLT namespace
      • getItemType

        public ItemType getItemType()
        Description copied from class: Instruction
        Get the item type of the items returned by evaluating this instruction
        Overrides:
        getItemType in class Instruction
        Returns:
        the static item type of the instruction
      • getCardinality

        public int getCardinality()
        Description copied from class: Expression
        Determine the static cardinality of the expression. This establishes how many items there will be in the result of the expression, at compile time (i.e., without actually evaluating the result.
        Overrides:
        getCardinality in class Expression
        Returns:
        one of the values Cardinality.ONE_OR_MORE, Cardinality.ZERO_OR_MORE, Cardinality.EXACTLY_ONE, Cardinality.ZERO_OR_ONE, Cardinality.EMPTY. This default implementation returns ZERO_OR_MORE (which effectively gives no information).
      • copy

        public Expression copy​(RebindingMap rebindings)
        Copy an expression. This makes a deep copy.
        Specified by:
        copy in class Expression
        Parameters:
        rebindings - variables to be re-bound
        Returns:
        the copy of the original expression
      • checkContentXSLT

        public static UnicodeString checkContentXSLT​(UnicodeString comment)
        Check the content of the comment according to the XSLT rules (which fix it if it is wrong)
        Parameters:
        comment - the proposed text of the comment
        Returns:
        the adjusted text of the comment
      • checkContentXQuery

        public static UnicodeString checkContentXQuery​(UnicodeString comment)
                                                throws XPathException
        Check the content of the comment according to the XQuery rules (which throw an error if it is wrong)
        Parameters:
        comment - the proposed text of the comment
        Returns:
        the adjusted text of the comment (always the same as the original if there is no error)
        Throws:
        XPathException - if the content is invalid
      • export

        public void export​(ExpressionPresenter out)
                    throws XPathException
        Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.
        Specified by:
        export in interface ExportAgent
        Specified by:
        export in class Expression
        Parameters:
        out - the expression presenter used to display the structure
        Throws:
        XPathException - if the export fails, for example if an expression is found that won't work in the target environment.