XSSFBReader.SheetIterator (poi-ooxml 5.2.2 API)

java.lang.Object
- org.apache.poi.xssf.eventusermodel.XSSFReader.SheetIterator
- - org.apache.poi.xssf.eventusermodel.XSSFBReader.SheetIterator

All Implemented Interfaces:: Iterator<InputStream>

Enclosing class:: XSSFBReader

public static class XSSFBReader.SheetIterator
extends XSSFReader.SheetIterator

Field Summary
- Fields inherited from class org.apache.poi.xssf.eventusermodel.XSSFReader.SheetIterator
  sheetIterator, sheetMap, xssfSheetRef

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected Iterator<XSSFReader.XSSFSheetRef>`	`createSheetIteratorFromWB(PackagePart wb)`
`CommentsTable`	`getSheetComments()`	Not supported by XSSFBReader's SheetIterator.
`protected Set<String>`	`getSheetRelationships()`	Gets string representations of relationships that are sheet-like.
`XSSFBCommentsTable`	`getXSSFBSheetComments()`

Methods inherited from class org.apache.poi.xssf.eventusermodel.XSSFReader.SheetIterator
getShapes, getSheetName, getSheetPart, hasNext, next, parseComments, remove

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

Methods inherited from interface java.util.Iterator
forEachRemaining

- Method Detail
  - getSheetRelationships
```
protected Set<String> getSheetRelationships()
```
    Description copied from class: XSSFReader.SheetIterator
    
    Gets string representations of relationships that are sheet-like. Added to allow subclassing by XSSFBReader. This is used to decide what relationships to load into the sheetRefs
    
    Overrides:
    
    getSheetRelationships in class XSSFReader.SheetIterator
    
    Returns:
    
    all relationships that are sheet-like
  - createSheetIteratorFromWB
```
protected Iterator<XSSFReader.XSSFSheetRef> createSheetIteratorFromWB(PackagePart wb)
                                                               throws IOException
```
    Overrides:
    
    createSheetIteratorFromWB in class XSSFReader.SheetIterator
    
    Throws:
    
    IOException
  - getSheetComments
```
public CommentsTable getSheetComments()
```
    Not supported by XSSFBReader's SheetIterator. Please use getXSSFBSheetComments() instead.
    
    Overrides:
    
    getSheetComments in class XSSFReader.SheetIterator
    
    Returns:
    
    nothing, always throws IllegalArgumentException!
  - getXSSFBSheetComments
```
public XSSFBCommentsTable getXSSFBSheetComments()
```