Class StreamAvailable

All Implemented Interfaces:
Callable, FunctionItem, GroundedValue, Item, Sequence

public class StreamAvailable extends SystemFunction implements Callable
This class implements the XSLT 3.0 function stream-available()
  • Constructor Details Link icon

    • StreamAvailable Link icon

      public StreamAvailable()
  • Method Details Link icon

    • call Link icon

      public BooleanValue call(XPathContext context, Sequence[] arguments) throws XPathException
      Call the Callable.
      Specified by:
      call in interface 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 methd 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 argument