net.sf.saxon.s9api.streams

Class AxisStep

java.lang.Object

net.sf.saxon.s9api.streams.Step<XdmNode>

net.sf.saxon.s9api.streams.AxisStep

All Implemented Interfaces:

Function<XdmItem,Stream<? extends XdmNode>>

class AxisStep
extends Step<XdmNode>

An AxisStep is a Step that implements one of the 13 XPath Axes.

Constructor Summary

Constructors

Constructor and Description
AxisStep(Axis axis)

Method Summary

Modifier and Type	Method and Description
Stream<? extends XdmNode>	apply(XdmItem node) Apply this function to the given argument.

Methods inherited from class net.sf.saxon.s9api.streams.Step

at, cat, first, last, then, where

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

AxisStep

public AxisStep(Axis axis)

Method Detail

apply

public Stream<? extends XdmNode> apply(XdmItem node)

Apply this function to the given argument. In other words, return a stream of nodes selected by this XPath axis, starting at the supplied origin

Parameters:

node - the origin node for the navigation

Returns:

the stream of nodes selected by the axis. The nodes are returned in Axis order (for a reverse axis like preceding-sibling or ancestor, this is the reverse of document order). If the supplied argument is not a node, return an empty stream.