StreamingCell (excel-streaming-reader 5.0.4 API)

java.lang.Object
- com.github.pjfanning.xlsx.impl.StreamingCell

All Implemented Interfaces:: Cell

public class StreamingCell
extends Object
implements Cell

Constructor Summary

Constructors
Constructor and Description
`StreamingCell(Sheet sheet, int columnIndex, int rowIndex, boolean use1904Dates)`
`StreamingCell(Sheet sheet, int columnIndex, Row row, boolean use1904Dates)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CellAddress`	`getAddress()`
`CellRangeAddress`	`getArrayFormulaRange()` Not supported
`boolean`	`getBooleanCellValue()` Get the value of the cell as a boolean.
`CellType`	`getCachedFormulaResultType()` Only valid for formula cells
`Comment`	`getCellComment()` Returns cell comment associated with this cell
`String`	`getCellFormula()` Return a formula for the cell, for example, `SUM(C4:E4)`
`CellStyle`	`getCellStyle()`
`CellType`	`getCellType()` Return the cell type.
`int`	`getColumnIndex()` Returns column index of this cell
`Date`	`getDateCellValue()` Get the value of the cell as a date.
`byte`	`getErrorCellValue()`
`Hyperlink`	`getHyperlink()` Returns hyperlink associated with this cell.
`LocalDateTime`	`getLocalDateTimeCellValue()`
`double`	`getNumericCellValue()` Get the value of the cell as a number.
`String`	`getNumericFormat()`
`XSSFRichTextString`	`getRichStringCellValue()` Get the value of the cell as a XSSFRichTextString
`Row`	`getRow()` Row is not guaranteed to be set.
`int`	`getRowIndex()` Returns row index of a row in the sheet that contains this cell
`Sheet`	`getSheet()`
`String`	`getStringCellValue()` Get the value of the cell as a string.
`boolean`	`isPartOfArrayFormulaGroup()` Not supported
`void`	`removeCellComment()` Update operations are not supported
`void`	`removeFormula()` Update operations are not supported
`void`	`removeHyperlink()` Update operations are not supported
`void`	`setAsActiveCell()` Update operations are not supported
`void`	`setBlank()` Update operations are not supported
`void`	`setCellComment(Comment comment)` Update operations are not supported
`void`	`setCellErrorValue(byte value)` Update operations are not supported
`void`	`setCellFormula(String formula)` Update operations are not supported
`void`	`setCellStyle(CellStyle cellStyle)`
`void`	`setCellType(CellType cellType)` Update operations are not supported
`void`	`setCellValue(boolean value)` Update operations are not supported
`void`	`setCellValue(Calendar value)` Update operations are not supported
`void`	`setCellValue(Date value)` Update operations are not supported
`void`	`setCellValue(double value)` Update operations are not supported
`void`	`setCellValue(LocalDate value)` Update operations are not supported
`void`	`setCellValue(LocalDateTime value)` Update operations are not supported
`void`	`setCellValue(RichTextString value)` Update operations are not supported
`void`	`setCellValue(String value)` Update operations are not supported
`void`	`setHyperlink(Hyperlink link)` Update operations are not supported

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

- Constructor Detail
  - StreamingCell
```
public StreamingCell(Sheet sheet,
                     int columnIndex,
                     int rowIndex,
                     boolean use1904Dates)
```
  - StreamingCell
```
public StreamingCell(Sheet sheet,
                     int columnIndex,
                     Row row,
                     boolean use1904Dates)
```
- Method Detail
  - getNumericFormat
```
public String getNumericFormat()
```
  - setCellStyle
```
public void setCellStyle(CellStyle cellStyle)
```
    Specified by:
    
    setCellStyle in interface Cell
  - getColumnIndex
```
public int getColumnIndex()
```
    Returns column index of this cell
    
    Specified by:
    
    getColumnIndex in interface Cell
    
    Returns:
    
    zero-based column index of a column in a sheet.
  - getRowIndex
```
public int getRowIndex()
```
    Returns row index of a row in the sheet that contains this cell
    
    Specified by:
    
    getRowIndex in interface Cell
    
    Returns:
    
    zero-based row index of a row in the sheet that contains this cell
  - getRow
```
public Row getRow()
```
    Row is not guaranteed to be set. Will return null when row is not set.
    
    Specified by:
    
    getRow in interface Cell
  - getSheet
```
public Sheet getSheet()
```
    Specified by:
    
    getSheet in interface Cell
  - getCellType
```
public CellType getCellType()
                     throws POIXMLException
```
    Return the cell type.
    
    Specified by:
    
    getCellType in interface Cell
    
    Returns:
    
    the cell type
    
    Throws:
    
    POIXMLException - if the value is not parseable
  - getStringCellValue
```
public String getStringCellValue()
                          throws POIXMLException
```
    Get the value of the cell as a string. For blank cells, we return an empty string.
    
    Specified by:
    
    getStringCellValue in interface Cell
    
    Returns:
    
    the value of the cell as a string
    
    Throws:
    
    POIXMLException - if the value is not parseable
  - getNumericCellValue
```
public double getNumericCellValue()
```
    Get the value of the cell as a number. For strings, we throw an exception. For blank cells, we return a 0.
    
    Specified by:
    
    getNumericCellValue in interface Cell
    
    Returns:
    
    the value of the cell as a number
    
    Throws:
    
    NumberFormatException - if the cell value isn't a parseable double.
  - getDateCellValue
```
public Date getDateCellValue()
```
    Get the value of the cell as a date. For strings, we throw an exception. For blank cells, we return a null.
    
    Specified by:
    
    getDateCellValue in interface Cell
    
    Returns:
    
    the value of the cell as a date
    
    Throws:
    
    IllegalStateException - if the cell type returned by getCellType() is CELL_TYPE_STRING
    
    NumberFormatException - if the cell value isn't a parseable double.
  - getBooleanCellValue
```
public boolean getBooleanCellValue()
```
    Get the value of the cell as a boolean. For strings, we throw an exception. For blank cells, we return a false.
    
    Specified by:
    
    getBooleanCellValue in interface Cell
    
    Returns:
    
    the value of the cell as a date
  - getCellStyle
```
public CellStyle getCellStyle()
```
    Specified by:
    
    getCellStyle in interface Cell
    
    Returns:
    
    the style of the cell
  - getCellFormula
```
public String getCellFormula()
```
    Return a formula for the cell, for example, SUM(C4:E4)
    
    Specified by:
    
    getCellFormula in interface Cell
    
    Returns:
    
    a formula for the cell
    
    Throws:
    
    IllegalStateException - if the cell type returned by getCellType() is not CELL_TYPE_FORMULA or if the cell has a shared formula that can't be evaluated
  - getRichStringCellValue
```
public XSSFRichTextString getRichStringCellValue()
                                          throws POIXMLException
```
    Get the value of the cell as a XSSFRichTextString
    For numeric cells, we throw an exception. For blank cells, we return an empty string. For formula cells, we return the pre-calculated value if a string, otherwise an exception
    
    Specified by:
    
    getRichStringCellValue in interface Cell
    
    Returns:
    
    the value of the cell as a XSSFRichTextString
    
    Throws:
    
    NotSupportedException - if the cell type is unsupported
    
    POIXMLException - if the value is not parseable
  - getCachedFormulaResultType
```
public CellType getCachedFormulaResultType()
                                    throws POIXMLException
```
    Only valid for formula cells
    
    Specified by:
    
    getCachedFormulaResultType in interface Cell
    
    Returns:
    
    one of (CellType.NUMERIC, CellType.STRING, CellType.BOOLEAN, CellType.ERROR) depending on the cached value of the formula
    
    Throws:
    
    IllegalStateException - if cell is not formula type
    
    NotSupportedException - if cell formula type is unknown
    
    POIXMLException - if the value is not parseable
  - getLocalDateTimeCellValue
```
public LocalDateTime getLocalDateTimeCellValue()
```
    Specified by:
    
    getLocalDateTimeCellValue in interface Cell
  - getErrorCellValue
```
public byte getErrorCellValue()
```
    Specified by:
    
    getErrorCellValue in interface Cell
  - getAddress
```
public CellAddress getAddress()
```
    Specified by:
    
    getAddress in interface Cell
  - getCellComment
```
public Comment getCellComment()
```
    Returns cell comment associated with this cell
    
    Specified by:
    
    getCellComment in interface Cell
    
    Returns:
    
    the cell comment associated with this cell or null
    
    Throws:
    
    IllegalStateException - if StreamingReader.Builder.setReadComments(boolean) is not set to true
  - getHyperlink
```
public Hyperlink getHyperlink()
```
    Returns hyperlink associated with this cell. This is not recommended as this data is stored at the end of the sheet. Use the hyperlink methods on sheet instance instead or keep this cell instance in memory until after all the rows have been read.
    
    Specified by:
    
    getHyperlink in interface Cell
    
    Returns:
    
    the hyperlink associated with this cell or null
    
    Throws:
    
    IllegalStateException - if StreamingReader.Builder.setReadHyperlinks(boolean) is not set to true
  - setCellType
```
public void setCellType(CellType cellType)
```
    Update operations are not supported
    
    Specified by:
    
    setCellType in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setBlank
```
public void setBlank()
```
    Update operations are not supported
    
    Specified by:
    
    setBlank in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setCellValue
```
public void setCellValue(double value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setCellValue
```
public void setCellValue(Date value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setCellValue
```
public void setCellValue(Calendar value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setCellValue
```
public void setCellValue(LocalDate value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setCellValue
```
public void setCellValue(LocalDateTime value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setCellValue
```
public void setCellValue(RichTextString value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setCellValue
```
public void setCellValue(String value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setCellFormula
```
public void setCellFormula(String formula)
```
    Update operations are not supported
    
    Specified by:
    
    setCellFormula in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - removeFormula
```
public void removeFormula()
```
    Update operations are not supported
    
    Specified by:
    
    removeFormula in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setCellValue
```
public void setCellValue(boolean value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setCellErrorValue
```
public void setCellErrorValue(byte value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellErrorValue in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setAsActiveCell
```
public void setAsActiveCell()
```
    Update operations are not supported
    
    Specified by:
    
    setAsActiveCell in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setCellComment
```
public void setCellComment(Comment comment)
```
    Update operations are not supported
    
    Specified by:
    
    setCellComment in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - removeCellComment
```
public void removeCellComment()
```
    Update operations are not supported
    
    Specified by:
    
    removeCellComment in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - setHyperlink
```
public void setHyperlink(Hyperlink link)
```
    Update operations are not supported
    
    Specified by:
    
    setHyperlink in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - removeHyperlink
```
public void removeHyperlink()
```
    Update operations are not supported
    
    Specified by:
    
    removeHyperlink in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - getArrayFormulaRange
```
public CellRangeAddress getArrayFormulaRange()
```
    Not supported
    
    Specified by:
    
    getArrayFormulaRange in interface Cell
    
    Throws:
    
    NotSupportedException - not supported
  - isPartOfArrayFormulaGroup
```
public boolean isPartOfArrayFormulaGroup()
```
    Not supported
    
    Specified by:
    
    isPartOfArrayFormulaGroup in interface Cell
    
    Throws:
    
    NotSupportedException - not supported

Class StreamingCell

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StreamingCell

StreamingCell

Method Detail

getNumericFormat

setCellStyle

getColumnIndex

getRowIndex

getRow

getSheet

getCellType

getStringCellValue

getNumericCellValue

getDateCellValue

getBooleanCellValue

getCellStyle

getCellFormula

getRichStringCellValue

getCachedFormulaResultType

getLocalDateTimeCellValue

getErrorCellValue

getAddress

getCellComment

getHyperlink

setCellType

setBlank

setCellValue

setCellValue

setCellValue

setCellValue

setCellValue

setCellValue

setCellValue

setCellFormula

removeFormula

setCellValue

setCellErrorValue

setAsActiveCell

setCellComment

removeCellComment

setHyperlink

removeHyperlink

getArrayFormulaRange

isPartOfArrayFormulaGroup