CompositeReaderContext (The Adobe Experience Manager SDK 2022.11.9850.20221116T162329Z-220900)

java.lang.Object
- org.apache.lucene.index.IndexReaderContext
- - org.apache.lucene.index.CompositeReaderContext

public final class CompositeReaderContext
extends IndexReaderContext

IndexReaderContext for CompositeReader instance.

Field Summary
- Fields inherited from class org.apache.lucene.index.IndexReaderContext
  docBaseInParent, isTopLevel, ordInParent, parent

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<IndexReaderContext>`	`children()`	Returns the context's children iff this context is a composite context otherwise `null`.
`java.util.List<AtomicReaderContext>`	`leaves()`	Returns the context's leaves if this context is a top-level context.
`CompositeReader`	`reader()`	Returns the `IndexReader`, this context represents.

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

- Method Detail
  - leaves
```
public java.util.List<AtomicReaderContext> leaves()
                                           throws java.lang.UnsupportedOperationException
```
    Description copied from class: IndexReaderContext
    
    Returns the context's leaves if this context is a top-level context. For convenience, if this is an AtomicReaderContext this returns itself as the only leaf.
    Note: this is convenience method since leaves can always be obtained by walking the context tree using IndexReaderContext.children().
    
    Specified by:
    
    leaves in class IndexReaderContext
    
    Throws:
    
    java.lang.UnsupportedOperationException - if this is not a top-level context.
    
    See Also:
    
    IndexReaderContext.children()
  - children
```
public java.util.List<IndexReaderContext> children()
```
    Description copied from class: IndexReaderContext
    
    Returns the context's children iff this context is a composite context otherwise null.
    
    Specified by:
    
    children in class IndexReaderContext
  - reader
```
public CompositeReader reader()
```
    Description copied from class: IndexReaderContext
    
    Returns the IndexReader, this context represents.
    
    Specified by:
    
    reader in class IndexReaderContext