The NormalisedEventIterator class
Several of the NormalisedEvent methods return an instance of the NormalisedEventIterator class, which provides a way to step though the name-value pairs making up the normalized event, forwards or backwards.
The following public methods are provided:
valid - Check whether the iterator points to a valid element of the normalized event. Typically used as part of the loop condition when iterating over the contents of an event.
key - Return the key (name) associated with the current event element pointed to by the iterator.
value - Return the value associated with the current event element pointed to by the iterator.
next - Move the iterator to the next element of the underlying normalized event instance. The iterator must be in a valid state (such that the
valid function would return
true) before this function is called. Note that the order in which elements is returned is not necessarily the same as the order in which they were added. The order may change as elements are added to or removed from the underlying event.
back - Move the iterator to the previous element of the underlying normalized event instance. The iterator must be in a valid state (such that the
valid function would return
true) before this function is called. Note that the order in which elements is returned is not necessarily the same as the order in which they were added. The order may change as elements are added to or removed from the underlying event.
There is no public constructor; iterators are created and returned only by NormalisedEvent methods.
See the Javadoc documentation for full information about the classes introduced in this section.