net.sf.saxon.expr
Class StringTokenIterator

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

All Implemented Interfaces:

SequenceIterator<StringValue>, UnfailingIterator<StringValue>

public class StringTokenIterator
extends Object
implements UnfailingIterator<StringValue>

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(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

void	close() Close the iterator.
StringValue	current() Get the current item in the sequence.
StringTokenIterator	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.
StringValue	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(String string)

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

Parameters:

string - the string to be tokenized

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.

Parameters:

string - the string to be tokenized

delimiters - the characters that are recognized as token separators

Method Detail

next

public StringValue next()

Description copied from interface: UnfailingIterator

Get the next item in the sequence.

Specified by:

next in interface SequenceIterator<StringValue>

Specified by:

next in interface UnfailingIterator<StringValue>

Returns:

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

current

public StringValue current()

Description copied from interface: UnfailingIterator

Get the current item in the sequence.

Specified by:

current in interface SequenceIterator<StringValue>

Specified by:

current in interface UnfailingIterator<StringValue>

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<StringValue>

Specified by:

position in interface UnfailingIterator<StringValue>

Returns:

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

close

public void close()

Description copied from interface: SequenceIterator

Close the iterator. This indicates to the supplier of the data that the client does not require any more items to be delivered by the iterator. This may enable the supplier to release resources. After calling close(), no further calls on the iterator should be made; if further calls are made, the effect of such calls is undefined.

(Currently, closing an iterator is important only when the data is being "pushed" in another thread. Closing the iterator terminates that thread and means that it needs to do no additional work. Indeed, failing to close the iterator may cause the push thread to hang waiting for the buffer to be emptied.)

Specified by:

close in interface SequenceIterator<StringValue>

getAnother

public StringTokenIterator 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<StringValue>

Specified by:

getAnother in interface UnfailingIterator<StringValue>

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<StringValue>

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.