Package net.sf.saxon.instruct
Class Comment
java.lang.Object
net.sf.saxon.expr.ComputedExpression
net.sf.saxon.instruct.Instruction
net.sf.saxon.instruct.SimpleNodeConstructor
net.sf.saxon.instruct.Comment
- All Implemented Interfaces:
Serializable
,SourceLocator
,Container
,Expression
,TailCallReturner
,InstructionInfoProvider
An instruction representing an xsl:comment element in the stylesheet.
- See Also:
-
Field Summary
Fields inherited from class net.sf.saxon.instruct.SimpleNodeConstructor
select
Fields inherited from class net.sf.saxon.expr.ComputedExpression
locationId, staticProperties
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected String
checkContent
(String comment, XPathContext context) Check the content of the node, and adjust it if necessaryvoid
display
(int level, PrintStream out, Configuration config) Display this instruction as an expression, for diagnosticsint
Determine the static cardinality of the expression.int
Get the instruction name, for diagnostics and tracing return the string "xsl:comment"Get the item type of the items returned by evaluating this instructionvoid
localTypeCheck
(StaticContext env, ItemType contextItemType) processLeavingTail
(XPathContext context) Process this instruction, to output a Comment NodeMethods inherited from class net.sf.saxon.instruct.SimpleNodeConstructor
computeSpecialProperties, createsNewNodes, evaluateItem, evaluateNameCode, expandChildren, getSelect, iterate, iterateSubExpressions, optimize, promoteInst, replaceSubExpression, setSelect, simplify, typeCheck
Methods inherited from class net.sf.saxon.instruct.Instruction
appendItem, assembleParams, assembleTunnelParams, computeCardinality, dynamicError, evaluateAsString, getImplementationMethod, getInstructionInfo, getSourceLocator, isXSLT, process, promote
Methods inherited from class net.sf.saxon.expr.ComputedExpression
adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, getColumnNumber, getConstructType, getDependencies, getExecutable, getHostLanguage, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, markTailFunctionCalls, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation, typeError
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.xml.transform.SourceLocator
getColumnNumber, getLineNumber, getPublicId, getSystemId
-
Constructor Details
-
Comment
public Comment()Construct the instruction
-
-
Method Details
-
getInstructionNameCode
public int getInstructionNameCode()Get the instruction name, for diagnostics and tracing return the string "xsl:comment"- Overrides:
getInstructionNameCode
in classInstruction
-
getItemType
Description copied from class:Instruction
Get the item type of the items returned by evaluating this instruction- Specified by:
getItemType
in interfaceExpression
- Overrides:
getItemType
in classInstruction
- Parameters:
th
-- Returns:
- the static item type of the instruction
-
getCardinality
public int getCardinality()Description copied from class:ComputedExpression
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.- Specified by:
getCardinality
in interfaceExpression
- Overrides:
getCardinality
in classComputedExpression
- 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).
-
localTypeCheck
- Specified by:
localTypeCheck
in classSimpleNodeConstructor
-
processLeavingTail
Process this instruction, to output a Comment Node- Specified by:
processLeavingTail
in interfaceTailCallReturner
- Specified by:
processLeavingTail
in classInstruction
- Parameters:
context
- the dynamic context for this transformation- Returns:
- a TailCall representing a call delegated to the caller. Always returns null in this implementation
- Throws:
XPathException
-
checkContent
Check the content of the node, and adjust it if necessary- Overrides:
checkContent
in classSimpleNodeConstructor
- Parameters:
comment
- the supplied contentcontext
- the dynamic context- Returns:
- the original content, unless adjustments are needed
- Throws:
DynamicError
- if the content is invalid
-
display
Description copied from class:SimpleNodeConstructor
Display this instruction as an expression, for diagnostics- Specified by:
display
in interfaceExpression
- Overrides:
display
in classSimpleNodeConstructor
- Parameters:
level
- indentation level for this expressionout
- Output destinationconfig
-
-