Implements org.apache.poi.ss.usermodel.Row.cellIterator.

Returns:Iterator<Cell>

cell iterator of the physically defined cells. Note that the 4th element might well not be cell 4, as the iterator will not return un-defined (null) cells. Call getCellNum() on the returned cells to know which cell they are. As this only ever works on physically defined cells, the org.apache.poi.ss.usermodel.Row.MissingCellPolicy has no effect.

Annotations

@Override

Implements java.lang.Comparable.compareTo.

Compares two HSSFRow objects. Two rows are equal if they belong to the same worksheet and their row indexes are equal.

Parameters

other:HSSFRow

the HSSFRow to be compared.

Returns:int

• the value 0 if the row number of this HSSFRow is equal to the row number of the argument HSSFRow
• a value less than 0 if the row number of this HSSFRow is numerically less than the row number of the argument HSSFRow
• a value greater than 0 if the row number of this HSSFRow is numerically greater than the row number of the argument HSSFRow

Annotations

@Override

Exceptions

IllegalArgumentException:

if the argument row belongs to a different worksheet

Copy the cells from srcRow to this row If this row is not a blank row, this will merge the two rows, overwriting the cells in this row with the cells in srcRow If srcRow is null, overwrite cells in destination row with blank values, styles, etc per cell copy policy srcRow may be from a different sheet in the same workbook

Parameters

srcRow:Row

the rows to copy from

policy:CellCopyPolicy

the policy to determine what gets copied

Annotations

@Beta

Copy the cells from srcRow to this row. If this row is not a blank row, this will merge the two rows, overwriting the cells in this row with the cells in srcRow. If srcRow is null, overwrite cells in destination row with blank values, styles, etc per cell copy policy. Note that if you are copying from a non-HSSF row then you will need to disable style copying in the CellCopyPolicy (HSSF styles are not compatible with XSSF styles, for instance).

Parameters

srcRow:Row

the rows to copy from

policy:CellCopyPolicy

the policy to determine what gets copied

context:CellCopyContext

the context - see CellCopyContext

Annotations

@Beta

Since

v5.1.0

Implements org.apache.poi.ss.usermodel.Row.createCell.

Use this to create new cells within the row and return it.

The cell that is returned is a CellType#BLANK. The type can be changed either through calling setCellValue or setCellType.

Parameters

column:int

- the column number this cell represents

Returns:HSSFCell

HSSFCell a high level representation of the created cell.

Annotations

@Override

Exceptions

IllegalArgumentException:

if columnIndex < 0 or greater than 255, the maximum number of columns supported by the Excel binary format (.xls)

Implements org.apache.poi.ss.usermodel.Row.createCell.

Use this to create new cells within the row and return it.

The cell that is returned will be of the requested type. The type can be changed either through calling setCellValue or setCellType, but there is a small overhead to doing this, so it is best to create the required type up front.

Parameters

columnIndex:int

- the column number this cell represents

type:CellType

Doc from org.apache.poi.ss.usermodel.Row.createCell.

- the cell's data type

Returns:HSSFCell

HSSFCell a high level representation of the created cell.

Annotations

@Override

Exceptions

IllegalArgumentException:

if columnIndex < 0 or greater than 255, the maximum number of columns supported by the Excel binary format (.xls)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.getCell.

Get the hssfcell representing a given column (logical cell) 0-based. If you ask for a cell that is not defined then you get a null, unless you have set a different org.apache.poi.ss.usermodel.Row.MissingCellPolicy on the base workbook.

Parameters

cellnum:int

0 based column number

Returns:HSSFCell

HSSFCell representing that column or null if undefined.

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.getCell.

Get the hssfcell representing a given column (logical cell) 0-based. If you ask for a cell that is not defined, then your supplied policy says what to do

Parameters

cellnum:int

0 based column number

policy:Row.MissingCellPolicy

Policy on blank / missing cells

Returns:HSSFCell

representing that column or null if undefined + policy allows.

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.getFirstCellNum.

get the number of the first cell contained in this row.

Returns:short

short representing the first logical cell in the row, or -1 if the row does not contain any cells.

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.getHeight.

get the row's height or ff (-1) for undefined/default-height in twips (1/20th of a point)

Returns:short

rowheight or 0xff for undefined (use sheet default)

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.getHeightInPoints.

get the row's height or ff (-1) for undefined/default-height in points (20*getHeight())

Returns:float

rowheight or 0xff for undefined (use sheet default)

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.getLastCellNum.

Gets the index of the last cell contained in this row PLUS ONE. The result also happens to be the 1-based column number of the last cell. This value can be used as a standard upper bound when iterating over cells:

short minColIx = row.getFirstCellNum();
short maxColIx = row.getLastCellNum();
for(short colIx=minColIx; colIx<maxColIx; colIx++) {
  HSSFCell cell = row.getCell(colIx);
  if(cell == null) {
    continue;
  }
  //... do something with cell
}

Returns:short

short representing the last logical cell in the row PLUS ONE, or -1 if the row does not contain any cells.

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.getOutlineLevel.

Returns the rows outline level. Increased as you put it into more groups (outlines), reduced as you take it out of them.

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.getPhysicalNumberOfCells.

gets the number of defined cells (NOT number of cells in the actual row!). That is to say if only columns 0,4,5 have values then there would be 3.

Returns:int

int representing the number of defined cells in the row.

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.getRowNum.

get row number this row represents

Returns:int

the row number (0 based)

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.getRowStyle.

Returns the whole-row cell styles. Most rows won't have one of these, so will return null. Call isFormatted() to check first.

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.getSheet.

Returns the HSSFSheet this row belongs to

Returns:HSSFSheet

the HSSFSheet that owns this row

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.getZeroHeight.

get whether or not to display this row with 0 height

Returns:boolean

- zHeight height is zero or not.

Annotations

@Override

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.isFormatted.

Is this row formatted? Most aren't, but some rows do have whole-row styles. For those that do, you can get the formatting from getRowStyle()

Annotations

@Override

Moves the supplied cell to a new column, which must not already have a cell there!

Parameters

cell:HSSFCell

The cell to move

newColumn:short

The new column number (0 based)

Implements org.apache.poi.ss.usermodel.Row.removeCell.

remove the HSSFCell from this row.

Parameters

cell:Cell

to remove

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.setHeight.

set the row's height or set to ff (-1) for undefined/default-height. Set the height in "twips" or 1/20th of a point.

Parameters

height:short

rowheight or -1 for undefined (use sheet default)

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.setHeightInPoints.

set the row's height in points.

Parameters

height:float

row height in points, -1 means to use the default height

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.setRowNum.

set the row number of this row.

Parameters

rowIndex:int

the row number (0-based)

Annotations

@Override

Exceptions

IndexOutOfBoundsException:

if the row number is not within the range 0-65535.

Applies a whole-row cell styling to the row.

Implements org.apache.poi.ss.usermodel.Row.setRowStyle.

Applies a whole-row cell styling to the row.

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.setZeroHeight.

set whether or not to display this row with 0 height

Parameters

zHeight:boolean

height is zero or not.

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.shiftCellsLeft.

Shifts column range [firstShiftColumnIndex-lastShiftColumnIndex] step places to the left.

Parameters

firstShiftColumnIndex:int

the column to start shifting

lastShiftColumnIndex:int

the column to end shifting

step:int

length of the shifting step

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Row.shiftCellsRight.

Shifts column range [firstShiftColumnIndex-lastShiftColumnIndex] step places to the right.

Parameters

firstShiftColumnIndex:int

the column to start shifting

lastShiftColumnIndex:int

the column to end shifting

step:int

length of the shifting step

Annotations

@Override