Interface PathIterator
All Known Implementing Classes:
-
public interface PathIterator
a sequence of positions which can be iterated over time.
See Also:
-
Field Summary |
|
INDEFINITEconstant meaning remaining time is unknown or can not be calculated |
Method Summary |
|
first()should return first position in sequence. |
|
hasNext()return true if sequnce is not ended. |
|
last()should return last position in sequence. |
|
next(float time)should return next position in sequence, should never return null. |
|
|
Field Detail
INDEFINITE
public static final float INDEFINITE
-
constant meaning remaining time is unknown or can not be calculated
Method Detail
next
-
should return next position in sequence, should never return null.
return last if has already reached end.
the implementation should return last if the sequence is completed or
time > remaining()
Parameters:
-
time - passed seconds, should be positive.
Returns:
-
next position in sequence
first
-
should return first position in sequence.
this method should not rewind iterator pointer
Returns:
-
first position in sequence
last
-
should return last position in sequence.
may return null for indefinite sequences.
this method should not advance iterator pointer
Returns:
-
last position in sequence
hasNext
boolean hasNext()
-
return true if sequnce is not ended. should be consistent with remaining,
that is if hasNext returns false, remanining should return 0 and vice versa
remaining
float remaining()
-
returns time left in seconds. returns INDEFINITE
if sequence is infinite or cannnot be calculated.
should be consistent with hasNext, that is if hasNext returns false,
remanining should return 0 and vice versa
-
See Also:
-
DocFlex/Doclet is both a multi-format Javadoc doclet and a free edition of DocFlex/Javadoc. If you need to customize your Javadoc without writing a full-blown doclet from scratch, DocFlex/Javadoc may be the only tool able to help you! Find out more at www.docflex.com