Class Error

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.Error

All Implemented Interfaces:

Callable, Function, GroundedValue, Item, Sequence

public class Error
extends SystemFunction
implements Callable

Implement XPath function fn:error()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Error.UserDefinedXPathException

Constructor Summary

Constructors

Constructor	Description
Error()

Method Summary

Modifier and Type	Method	Description
Sequence	call(XPathContext context, Sequence[] arguments)	Invoke the function
Item	error(XPathContext context, QNameValue errorCode, StringValue desc, SequenceIterator errObject)
int	getSpecialProperties(Expression[] arguments)	Determine the special properties of this function.
boolean	isVacuousExpression()	Determine whether this is a vacuous expression as defined in the XQuery update specification

Methods inherited from class SystemFunction

dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, exportAttributes, fixArguments, getArity, getCardinality, getCompilerName, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getStaticBaseUriString, getStreamerName, importAttributes, isTrustedResultType, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, toShortString, toString, typeCheckCaller

Methods inherited from class AbstractFunction

atomize, deepEquals, effectiveBooleanValue, getAnnotations, getStringValue, getStringValueCS, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Function

getGenre

Methods inherited from interface GroundedValue

asIterable, concatenate, containsNode, materialize

Methods inherited from interface Item

getLength, head, isStreamed, itemAt, iterate, reduce, subsequence

Methods inherited from interface Sequence

makeRepeatable

Constructor Details

Error

public Error()

Method Details

getSpecialProperties

public int getSpecialProperties(Expression[] arguments)

Description copied from class: SystemFunction

Determine the special properties of this function. The general rule is that a system function call is non-creative unless more details are defined in a subclass.

Overrides:

getSpecialProperties in class SystemFunction

Parameters:

arguments - the actual arguments supplied in a call to the function

isVacuousExpression

public boolean isVacuousExpression()

Determine whether this is a vacuous expression as defined in the XQuery update specification

Returns:

true if this expression is vacuous

error

public Item error(XPathContext context,
 QNameValue errorCode,
 StringValue desc,
 SequenceIterator errObject)
           throws XPathException

Throws:

XPathException

call

public Sequence call(XPathContext context,
 Sequence[] arguments)
              throws XPathException

Description copied from interface: Function

Invoke the function

Specified by:

call in interface Callable

Specified by:

call in interface Function

Parameters:

context - the XPath dynamic evaluation context

arguments - the actual arguments to be supplied

Returns:

the result of invoking the function

Throws:

XPathException - if a dynamic error occurs within the function