Package org.apache.lucene.util.automaton
Class LimitedFiniteStringsIterator
- java.lang.Object
-
- org.apache.lucene.util.automaton.FiniteStringsIterator
-
- org.apache.lucene.util.automaton.LimitedFiniteStringsIterator
-
public class LimitedFiniteStringsIterator extends FiniteStringsIterator
FiniteStringsIteratorwhich limits the number of iterated accepted strings. If more thanlimitstrings are accepted, the firstlimitstrings found are returned.If the
Automatonhas cycles then this iterator may throw anIllegalArgumentException, but this is not guaranteed!Be aware that the iteration order is implementation dependent and may change across releases.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Constructor Summary
Constructors Constructor Description LimitedFiniteStringsIterator(Automaton a, int limit)Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IntsRefnext()Generate next finite string.intsize()Number of iterated finite strings.
-
-
-
Constructor Detail
-
LimitedFiniteStringsIterator
public LimitedFiniteStringsIterator(Automaton a, int limit)
Constructor.- Parameters:
a- Automaton to create finite string from.limit- Maximum number of finite strings to create, or -1 for infinite.
-
-
Method Detail
-
next
public IntsRef next()
Description copied from class:FiniteStringsIteratorGenerate next finite string. The return value is just valid until the next call of this method!- Overrides:
nextin classFiniteStringsIterator- Returns:
- Finite string or null, if no more finite strings are available.
-
size
public int size()
Number of iterated finite strings.
-
-