path
Interface PathIterator

public interface PathIterator

A PathIterator iterates over the sub-paths of a Path. Note that PathIterator extends EdgeIterator. Thus, an implementation of PathIterator must include a hasNext() function. When you call the next() function on an EdgeIterator, you will get a Segment. That is, something with a beginning and an end. When you call it on a PathIterator you get a Path, which is a special type of Segment. Thus, it is natural for the PathIterator to extend EdgeIterator, because it can be treated as one. That is, the output of next() in PathIterator can be either treated as a Segment or a Path.

Method Summary

boolean	hasNext() Return true when the iterator will return another sub-path with a call to next().
Path	next() Returns the next sub-path.

Method Detail

hasNext

boolean hasNext()

Return true when the iterator will return another sub-path with a call to next(). Returns false otherwise.

next

Path next()

Returns the next sub-path.