Package com.saxonica.functions.extfn

Class VendorFunctionSetPE.DiscardDocument

  • All Implemented Interfaces:
    Callable, FunctionItem, GroundedValue, Item, Sequence
    Enclosing class:
    VendorFunctionSetPE
    public static class VendorFunctionSetPE.DiscardDocument
extends SystemFunction
    Implement the saxon:discard-document() function, which returns its argument unchanged, but with the side-effect of removing it from the document pool, making it eligible for garbage collection.

    • Constructor Detail

      • DiscardDocument

        public DiscardDocument()

    • Method Detail

      • call

        public Sequence call​(XPathContext context,
                     Sequence[] arguments)
              throws XPathException
        Description copied from interface: Callable
        Call the Callable.
        Parameters:
        context - the dynamic evaluation context
        arguments - the values of the arguments, supplied as Sequences.

        Generally it is advisable, if calling iterate() to process a supplied sequence, to call it only once; if the value is required more than once, it should first be converted to a GroundedValue by calling the utility method SequenceTool.toGroundedValue().

        If the expected value is a single item, the item should be obtained by calling Sequence.head(): it cannot be assumed that the item will be passed as an instance of Item or AtomicValue.

        It is the caller's responsibility to perform any type conversions required to convert arguments to the type expected by the callee. An exception is where this Callable is explicitly an argument-converting wrapper around the original Callable.

        Returns:
        the result of the evaluation, in the form of a Sequence. It is the responsibility of the callee to ensure that the type of result conforms to the expected result type.
        Throws:
        XPathException - if a dynamic error occurs during the evaluation of the expression