Row (EasyRPA Open Framework - Google Sheets 1.0.0 API)

java.lang.Object
- eu.easyrpa.openframework.google.sheets.Row

All Implemented Interfaces:

Iterable<Cell>
```
public class Row
extends Object
implements Iterable<Cell>
```
Represents specific row of Spreadsheet document and provides functionality to work with it.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Row(Sheet parent, int rowIndex)
Creates a new instance of row.

Constructors
Modifier	Constructor and Description
`protected`	`Row(Sheet parent, int rowIndex)` Creates a new instance of row.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Cell`	`addCell(Object value)` Creates a new cell at the end of this row and sets to it given value.
`Cell`	`createCell(int colIndex)` Creates a new cell at the given column index and returns its representing object.
`Cell`	`getCell(int colIndex)` Gets the cell of this row represented by given column index.
`Cell`	`getCell(String cellRef)` Gets the cell of this row represented by given reference.
`SpreadsheetDocument`	`getDocument()` Gets parent Spreadsheet document.
`int`	`getFirstCellIndex()` Gets index of the first defined cell on this row.
`com.google.api.services.sheets.v4.model.RowData`	`getGRow()` Returns underlay Google API object representing this row.
`int`	`getIndex()` Gets index of this row.
`int`	`getLastCellIndex()` Gets index of the last cell of this row.
`List<Object>`	`getRange(int startCol, int endCol)` Gets values of cells range on this row.
`<T> List<T>`	`getRange(int startCol, int endCol, Class<T> valueType)` Gets values of cells range on this row and converts them to the type specified by `valueType`.
`List<Object>`	`getRange(String startRef, String endRef)` Gets values of cells range of this row.
`<T> List<T>`	`getRange(String startRef, String endRef, Class<T> valueType)` Gets values of cells range on this row and converts them to the type specified by `valueType`.
`CellRef`	`getReference()` Gets reference to this row.
`Sheet`	`getSheet()` Gets parent sheet.
`Object`	`getValue(int colIndex)` Gets the value of this row cell by given column index.
`<T> T`	`getValue(int colIndex, Class<T> valueType)` Gets the value of this row cell by given column index.
`Object`	`getValue(String cellRef)` Gets the value of this row cell by given cell reference.
`<T> T`	`getValue(String cellRef, Class<T> valueType)` Gets the value of this row cell by given cell reference and converts it to the type specified by `valueType`.
`List<Object>`	`getValues()` Gets values of all row cells.
`<T> List<T>`	`getValues(Class<T> valueType)` Gets values of all row cells.
`Iterator<Cell>`	`iterator()` Returns an iterator of objects representing existing cells of this row.
`void`	`putRange(int startCol, List<?> values)` Sets given values to cells range of this row which starts from cell with column index defined by `startCol`.
`void`	`putRange(String startRef, List<?> values)` Sets given values to cells range of this row which starts from cell defined by `startRef`.
`void`	`setValue(int colIndex, Object value)` Sets the value of this row cell by given column index.
`void`	`setValue(String cellRef, Object value)` Sets the value of this row cell by given cell reference.
`void`	`setValues(List<?> values)` Sets given values to cells range of this row which starts from cell with column index 0.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Row
```
protected Row(Sheet parent,
              int rowIndex)
```
    Creates a new instance of row.
    
    Parameters:
    
    parent - reference to parent sheet.
    
    rowIndex - 0-based index of this row.
- Method Detail
  - getDocument
```
public SpreadsheetDocument getDocument()
```
    Gets parent Spreadsheet document.
    
    Returns:
    
    parent Spreadsheet document.
  - getSheet
```
public Sheet getSheet()
```
    Gets parent sheet.
    
    Returns:
    
    parent sheet.
  - getIndex
```
public int getIndex()
```
    Gets index of this row.
    
    Returns:
    
    0-based index of this row.
  - getReference
```
public CellRef getReference()
```
    Gets reference to this row.
    Row reference is a reference to its cell with column index 0.
    
    Returns:
    
    this row reference.
    
    See Also:
    
    CellRef
  - getValue
```
public Object getValue(String cellRef)
```
    Gets the value of this row cell by given cell reference.
    
    Parameters:
    
    cellRef - reference string to necessary cell. E.g. "A23".
    
    Returns:
    
    value of corresponding cell or null if nothing is found. The actual class of value is depend on cell type. Can be returned Double, Boolean, LocalDateTime or String.
  - getValue
```
public <T> T getValue(String cellRef,
                      Class<T> valueType)
```
    Gets the value of this row cell by given cell reference and converts it to the type specified by valueType.
    If valueType is String.class, Byte.class, Short.class, Integer.class, Long.class, Float.class or Double.class this method performs automatic conversion of cell values to corresponding type or null if the conversion fails.
    For other types it performs simple type casting of cell values to T or throws ClassCastException if such type casting is not possible.
    
    Type Parameters:
    
    T - type of returning value. Defined by value of valueType.
    
    Parameters:
    
    cellRef - reference string to necessary cell. E.g. "A23".
    
    valueType - class instance of returning value.
    
    Returns:
    
    value of corresponding cell or null if nothing is found. The class of return value is defined by valueType. If the actual class of cell value is different from valueType the automatic conversion will be applied.
    
    Throws:
    
    ClassCastException - if T is different from String or Number and the value of cell cannot be cast to T.
  - getValue
```
public Object getValue(int colIndex)
```
    Gets the value of this row cell by given column index.
    
    Parameters:
    
    colIndex - 0-based column index of the cell.
    
    Returns:
    
    value of corresponding cell or null if nothing is found. The actual class of value is depend on cell type. Can be returned Double, Boolean, LocalDateTime or String.
  - getValue
```
public <T> T getValue(int colIndex,
                      Class<T> valueType)
```
    Gets the value of this row cell by given column index. The return value is automatically converted to the type specified by valueType.
    If valueType is String.class, Byte.class, Short.class, Integer.class, Long.class, Float.class or Double.class this method performs automatic conversion of cell values to corresponding type or null if the conversion fails.
    For other types it performs simple type casting of cell values to T or throws ClassCastException if such type casting is not possible.
    
    Type Parameters:
    
    T - type of returning value. Defined by value of valueType.
    
    Parameters:
    
    colIndex - 0-based column index of the cell.
    
    valueType - class instance of returning value.
    
    Returns:
    
    value of corresponding cell or null if nothing is found. The class of return value is defined by valueType. If the actual class of cell value is different from valueType the automatic conversion will be applied.
    
    Throws:
    
    ClassCastException - if T is different from String or Number and the value of cell cannot be cast to T.
  - setValue
```
public void setValue(String cellRef,
                     Object value)
```
    Sets the value of this row cell by given cell reference.
    
    Parameters:
    
    cellRef - reference string to necessary cell. E.g. "A23".
    
    value - the value to set.
  - setValue
```
public void setValue(int colIndex,
                     Object value)
```
    Sets the value of this row cell by given column index.
    
    Parameters:
    
    colIndex - 0-based column index of the cell.
    
    value - the value to set.
  - getValues
```
public List<Object> getValues()
```
    Gets values of all row cells.
    It's an equivalent to getting of range between first and last cells of this row.
    
    Returns:
    
    list of values of this row cells. Returns empty list if row is empty. The actual class of values in list depend on cell types. Can be Double, Boolean, LocalDateTime or String.
    
    See Also:
    
    getRange(int, int, Class), getFirstCellIndex(), getLastCellIndex()
  - getValues
```
public <T> List<T> getValues(Class<T> valueType)
```
    Gets values of all row cells.
    Returning values are automatically converted to the type specified by valueType.
    It's an equivalent to getting of range between first and last cells of this row.
    
    Type Parameters:
    
    T - type of returning values. Defined by value of valueType.
    
    Parameters:
    
    valueType - class instance of returning values.
    
    Returns:
    
    list of values of this row cells. Returns empty list if row is empty. The class of returning values is defined by valueType. If the actual class of cell values is different from valueType the automatic conversion will be applied.
    
    See Also:
    
    getRange(int, int, Class), getFirstCellIndex(), getLastCellIndex()
  - setValues
```
public void setValues(List<?> values)
```
    Sets given values to cells range of this row which starts from cell with column index 0.
    The end cell of the range is defined by size of given values.
    It's an equivalent to putRange(0, values).
    
    Parameters:
    
    values - list of values to set.
    
    See Also:
    
    putRange(int, List)
  - getRange
```
public List<Object> getRange(String startRef,
                             String endRef)
```
    Gets values of cells range of this row. The range is defined by given start and end cell references.
    
    Parameters:
    
    startRef - reference string to the start cell of the range. Only column part is taken into consideration. E.g. "A23".
    
    endRef - reference string to the end cell of the range. Only column part is taken into consideration. E.g. "D23".
    
    Returns:
    
    list of values of the cells range. Returns empty list if specified range is empty. The actual class of values in list depend on cell types. Can be Double, Boolean, LocalDateTime or String.
    
    See Also:
    
    getRange(int, int, Class)
  - getRange
```
public <T> List<T> getRange(String startRef,
                            String endRef,
                            Class<T> valueType)
```
    Gets values of cells range on this row and converts them to the type specified by valueType. The range is defined by given start and end cell references.
    If valueType is String.class, Byte.class, Short.class, Integer.class, Long.class, Float.class or Double.class this method performs automatic conversion of cell values to corresponding type or null if the conversion fails.
    For other types it performs simple type casting of cell values to T or throws ClassCastException if such type casting is not possible.
    
    Type Parameters:
    
    T - type of returning cell values. Defined by value of valueType.
    
    Parameters:
    
    startRef - reference string to the start cell of the range. Only column part is taken into consideration. E.g. "A23".
    
    endRef - reference string to the end cell of the range. Only column part is taken into consideration. E.g. "D23".
    
    valueType - class instance of returning cell values.
    
    Returns:
    
    list of values of the cells range. Returns empty list if specified range is empty. The class of return cell values is defined by valueType. If the actual class of cell values is different from valueType the automatic conversion will be applied.
    
    Throws:
    
    ClassCastException - if T is different from String or Number and the value of cell cannot be cast to T.
  - getRange
```
public List<Object> getRange(int startCol,
                             int endCol)
```
    Gets values of cells range on this row. The range is defined by given left and right column indexes.
    
    Parameters:
    
    startCol - 0-based index of left column of the range.
    
    endCol - 0-based index of right column of the range.
    
    Returns:
    
    list of values of the cells range. Returns empty list if specified range is empty. The actual class of values depend on cell types. Can be Double, Boolean, LocalDateTime or String.
  - getRange
```
public <T> List<T> getRange(int startCol,
                            int endCol,
                            Class<T> valueType)
```
    Gets values of cells range on this row and converts them to the type specified by valueType. The range is defined by given left and right column indexes.
    If valueType is String.class, Byte.class, Short.class, Integer.class, Long.class, Float.class or Double.class this method performs automatic conversion of cell values to corresponding type or null if the conversion fails.
    For other types it performs simple type casting of cell values to T or throws ClassCastException if such type casting is not possible.
    
    Type Parameters:
    
    T - type of returning cell values. Defined by value of valueType.
    
    Parameters:
    
    startCol - 0-based index of left column of the range.
    
    endCol - 0-based index of right column of the range.
    
    valueType - class instance of returning cell values.
    
    Returns:
    
    list of values of the cells range. Returns empty list if specified range is empty. The class of return cell values is defined by valueType. If the actual class of cell values is different from valueType the automatic conversion will be applied.
    
    Throws:
    
    ClassCastException - if T is different from String or Number and the value of cell cannot be cast to T.
  - putRange
```
public void putRange(String startRef,
                     List<?> values)
```
    Sets given values to cells range of this row which starts from cell defined by startRef.
    The end cell of the range is defined by size of given values.
    
    Parameters:
    
    startRef - reference string to the start cell of the range. E.g. "A23".
    
    values - list of values to set.
  - putRange
```
public void putRange(int startCol,
                     List<?> values)
```
    Sets given values to cells range of this row which starts from cell with column index defined by startCol.
    The end cell of the range is defined by size of given values.
    
    Parameters:
    
    startCol - 0-based column index of the start cell of the range.
    
    values - list of values to set.
  - getCell
```
public Cell getCell(String cellRef)
```
    Gets the cell of this row represented by given reference.
    
    Parameters:
    
    cellRef - reference string to necessary cell. Only column part is taken into consideration. E.g. "A23".
    
    Returns:
    
    instance of corresponding cell or null if cell is not defined.
  - getCell
```
public Cell getCell(int colIndex)
```
    Gets the cell of this row represented by given column index.
    
    Parameters:
    
    colIndex - 0-based column index of necessary cell.
    
    Returns:
    
    instance of corresponding cell or null if cell is not defined.
  - createCell
```
public Cell createCell(int colIndex)
```
    Creates a new cell at the given column index and returns its representing object.
    
    Parameters:
    
    colIndex - 0-based column index where cell should be created.
    
    Returns:
    
    object representing the created cell.
  - addCell
```
public Cell addCell(Object value)
```
    Creates a new cell at the end of this row and sets to it given value.
    
    Parameters:
    
    value - the cell value to set.
    
    Returns:
    
    object representing the created cell.
  - getFirstCellIndex
```
public int getFirstCellIndex()
```
    Gets index of the first defined cell on this row.
    Cell is defined if underlying POI object is not null.
    
    Returns:
    
    0-based index of the first defined cell on this row or -1 if no cells exist.
  - getLastCellIndex
```
public int getLastCellIndex()
```
    Gets index of the last cell of this row.
    
    Returns:
    
    0-based index of the last cell of this row or -1 if no cells exist.
  - iterator
```
public Iterator<Cell> iterator()
```
    Returns an iterator of objects representing existing cells of this row. Meaning it won't iterate over undefined cells.
    This method allows using of this row object in "for" loop:
```
     for(Cell cell: row){
         int colIndex = cell.getColumnIndex();
         ...
     }
 
```
    Specified by:
    
    iterator in interface Iterable<Cell>
    
    Returns:
    
    on iterator of objects representing existing cell of this row.
  - getGRow
```
public com.google.api.services.sheets.v4.model.RowData getGRow()
```
    Returns underlay Google API object representing this row. This object can be used directly if some specific Google API functionality is necessary within RPA process.
    
    Returns:
    
    Google API object representing this row.

Class Row

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Row

Method Detail

getDocument

getSheet

getIndex

getReference

getValue

getValue

getValue

getValue

setValue

setValue

getValues

getValues

setValues

getRange

getRange

getRange

getRange

putRange

putRange

getCell

getCell

createCell

addCell

getFirstCellIndex

getLastCellIndex

iterator

getGRow