net.sf.saxon.expr
Class StringTokenIterator

java.lang.Object
  net.sf.saxon.expr.StringTokenIterator

All 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.

Field Summary

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

GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

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

StringTokenIterator(java.lang.String string, java.lang.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() Get the current item in the sequence.
SequenceIterator	getAnother() Get another iterator over the same sequence of items, positioned at the start of the sequence.
int	getProperties() Get properties of this iterator, as a bit-significant integer.
Item	next() Get the next item in the sequence.
int	position() Get the current position

Methods inherited from class java.lang.Object

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

Constructor Detail

StringTokenIterator

public StringTokenIterator(java.lang.String string)

Construct a StringTokenIterator that will break the supplied string into tokens at whitespace boundaries

StringTokenIterator

public StringTokenIterator(java.lang.String string,
                           java.lang.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 Detail

next

public Item next()

Description copied from interface: UnfailingIterator

Get the next item in the sequence.

Specified by:

next in interface SequenceIterator

Specified by:

next in interface UnfailingIterator

Returns:

the next Item. If there are no more nodes, return null.

current

public Item current()

Description copied from interface: UnfailingIterator

Get the current item in the sequence.

Specified by:

current in interface SequenceIterator

Specified by:

current in interface UnfailingIterator

Returns:

the current item, that is, the item most recently returned by next()

position

public int position()

Description copied from interface: UnfailingIterator

Get the current position

Specified by:

position in interface SequenceIterator

Specified by:

position in interface UnfailingIterator

Returns:

the position of the current item (the item most recently returned by next()), starting at 1 for the first node

getAnother

public SequenceIterator getAnother()

Description copied from interface: UnfailingIterator

Get another iterator over the same sequence of items, positioned at the start of the sequence. It must be possible to call this method at any time, whether none, some, or all of the items in the original iterator have been read. The method is non-destructive: it does not change the state of the original iterator.

Specified by:

getAnother in interface SequenceIterator

Specified by:

getAnother in interface UnfailingIterator

Returns:

a new iterator over the same sequence

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.