net.sf.saxon.expr

Class StringTokenIterator

Implemented Interfaces:
SequenceIterator, UnfailingIterator

public class StringTokenIterator
extends java.lang.Object
implements UnfailingIterator

StringTokenIterator: breaks a string up into tokens, and returns the tokens as a sequence of strings.

Fields inherited from interface net.sf.saxon.om.SequenceIterator

GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

StringTokenIterator(String string)
Construct a StringTokenIterator that will break the supplied string into tokens at whitespace boundaries
StringTokenIterator(String string, String delimiters)
Construct a StringTokenIterator that will break the supplied string into tokens at any of the delimiter characters included in the delimiter string.

Method Summary

Item
current()
SequenceIterator
getAnother()
int
getProperties()
Get properties of this iterator, as a bit-significant integer.
Item
next()
int
position()

Constructor Details

StringTokenIterator

public StringTokenIterator(String string)
Construct a StringTokenIterator that will break the supplied string into tokens at whitespace boundaries

StringTokenIterator

public StringTokenIterator(String string,
                           String delimiters)
Construct a StringTokenIterator that will break the supplied string into tokens at any of the delimiter characters included in the delimiter string.

Method Details

current

public Item current()
Specified by:
current in interface UnfailingIterator
current in interface SequenceIterator

getAnother

public SequenceIterator getAnother()
Specified by:
getAnother in interface UnfailingIterator
getAnother in interface SequenceIterator

getProperties

public int getProperties()
Get properties of this iterator, as a bit-significant integer.
Specified by:
getProperties in interface SequenceIterator
Returns:
the properties of this iterator. This will be some combination of properties such as SequenceIterator.GROUNDED, SequenceIterator.LAST_POSITION_FINDER, and SequenceIterator.LOOKAHEAD. It is always acceptable to return the value zero, indicating that there are no known special properties. It is acceptable for the properties of the iterator to change depending on its state.

next

public Item next()
Specified by:
next in interface UnfailingIterator
next in interface SequenceIterator

position

public int position()
Specified by:
position in interface UnfailingIterator
position in interface SequenceIterator