net.sf.saxon.instruct
Class Comment

java.lang.Object
  |
  +--net.sf.saxon.instruct.Instruction
        |
        +--net.sf.saxon.instruct.ExprInstruction
              |
              +--net.sf.saxon.instruct.SimpleNodeConstructor
                    |
                    +--net.sf.saxon.instruct.Comment
All Implemented Interfaces:
Expression, Instr, Locatable, java.io.Serializable, javax.xml.transform.SourceLocator

public final class Comment
extends SimpleNodeConstructor

An instruction representing an xsl:comment element in the stylesheet.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.saxon.instruct.SimpleNodeConstructor
select, separator
 
Fields inherited from class net.sf.saxon.instruct.Instruction
children
 
Constructor Summary
Comment()
          Construct the instruction
 
Method Summary
 void display(int level, NamePool pool)
          Display this instruction as an expression, for diagnostics
 int getCardinality()
          Determine the static cardinality of the expression.
 java.lang.String getInstructionName()
          Get the instruction name, for diagnostics and tracing return the string "xsl:comment"
 ItemType getItemType()
          Determine the data type of the expression, if possible.
 TailCall processLeavingTail(XPathContext context)
          Process this instruction, to output a Comment Node
 void typeCheck(StaticContext env)
           
 
Methods inherited from class net.sf.saxon.instruct.SimpleNodeConstructor
analyze, evaluateItem, evaluateNameCode, expandChildren, getXPathExpressions, promoteInst, setSelect, setSeparator
 
Methods inherited from class net.sf.saxon.instruct.ExprInstruction
effectiveBooleanValue, evaluateAsString, getDependencies, getSpecialProperties, getSubExpressions, iterate, promote, simplify
 
Methods inherited from class net.sf.saxon.instruct.Instruction
assembleParams, assembleTunnelParams, displayChildren, dynamicError, dynamicError, getChildren, getColumnNumber, getExecutable, getInstructionNamespace, getLineNumber, getPublicId, getSourceLocator, getSystemId, process, processChildren, processChildrenLeavingTail, recoverableError, setChildren, setExecutable, setSourceLocation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Comment

public Comment()
Construct the instruction

Method Detail

getInstructionName

public java.lang.String getInstructionName()
Get the instruction name, for diagnostics and tracing return the string "xsl:comment"

Specified by:
getInstructionName in class Instruction

getItemType

public ItemType getItemType()
Description copied from interface: Expression
Determine the data type of the expression, if possible. All expression return sequences, in general; this method determines the type of the items within the sequence, assuming that (a) this is known in advance, and (b) it is the same for all items in the sequence.

This method should always return a result, though it may be the best approximation that is available at the time.

Specified by:
getItemType in interface Expression
Overrides:
getItemType in class Instruction
Returns:
a value such as Type.STRING, Type.BOOLEAN, Type.NUMBER, Type.NODE, or Type.ITEM (meaning not known at compile time)

getCardinality

public int getCardinality()
Description copied from interface: 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.

This method should always return a result, though it may be the best approximation that is available at the time.

Specified by:
getCardinality in interface Expression
Overrides:
getCardinality in class Instruction
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).

typeCheck

public void typeCheck(StaticContext env)
Specified by:
typeCheck in class SimpleNodeConstructor

processLeavingTail

public TailCall processLeavingTail(XPathContext context)
                            throws javax.xml.transform.TransformerException
Process this instruction, to output a Comment Node

Specified by:
processLeavingTail in interface Instr
Specified by:
processLeavingTail in class Instruction
Parameters:
context - the dynamic context for this transformation
Returns:
a TailCall representing a call delegated to the caller. Always returns null in this implementation
javax.xml.transform.TransformerException

display

public void display(int level,
                    NamePool pool)
Description copied from class: SimpleNodeConstructor
Display this instruction as an expression, for diagnostics

Specified by:
display in interface Expression
Overrides:
display in class SimpleNodeConstructor
Parameters:
level - indentation level for this expression