MultiCategoryListIterator (Lucene 3.6.2 API)

Skip navigation links

Prev Class
Next Class

All Classes

SEARCH:

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.lucene.facet.util.MultiCategoryListIterator

All Implemented Interfaces:

CategoryListIterator
```
public class MultiCategoryListIterator
extends Object
implements CategoryListIterator
```
Iterates over multiple CategoryListIterators, consuming the provided iterators in order.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Constructor Summary

Constructors
Constructor Description

MultiCategoryListIterator(CategoryListIterator... iterators)
Receives the iterators to iterate on

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`init()`	Fails if all given iterators fail to init
`long`	`nextCategory()`	Return a value larger than `Integer.MAX_VALUE` only if all iterators are exhausted
`boolean`	`skipTo(int docId)`	Fails only if skipTo on all the provided iterators returned `false`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MultiCategoryListIterator
```
public MultiCategoryListIterator(CategoryListIterator... iterators)
```
    Receives the iterators to iterate on
- Method Detail
  - init
```
public boolean init()
             throws IOException
```
    Fails if all given iterators fail to init
    
    Specified by:
    
    init in interface CategoryListIterator
    
    Throws:
    
    IOException
  - nextCategory
```
public long nextCategory()
                  throws IOException
```
    Return a value larger than Integer.MAX_VALUE only if all iterators are exhausted
    
    Specified by:
    
    nextCategory in interface CategoryListIterator
    
    Throws:
    
    IOException
  - skipTo
```
public boolean skipTo(int docId)
               throws IOException
```
    Fails only if skipTo on all the provided iterators returned false
    
    Specified by:
    
    skipTo in interface CategoryListIterator
    
    Throws:
    
    IOException

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2000-2018 Apache Software Foundation. All Rights Reserved.