Modifier and Type	Class and Description
public static enum	CellRangeAddressBase.CellPosition Indicates a cell or range is in the given relative position in a range.
private static class	CellRangeAddressBase.RowMajorCellAddressIterator Iterates over the cell addresses in a cell range in row major order The iterator is unaffected by changes to the CellRangeAddressBase instance after the iterator is created.

Modifier and Type	Field and Description
private int	_firstCol
private int	_firstRow
private int	_lastCol
private int	_lastRow

Access	Constructor and Description
protected	CellRangeAddressBase(int firstRow, int lastRow, int firstCol, int lastCol)

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the range contains the column [colInd] containsColumn(int the column to check colInd) Check if the column is in the specified cell range
public boolean	Returns: true if the range contains the row [rowInd] containsRow(int the row to check rowInd) Check if the row is in the specified cell range
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final int	Returns: column number for the upper left hand corner getFirstColumn()
public final int	Returns: row number for the upper left hand corner getFirstRow()
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public final int	Returns: column number for the lower right hand corner getLastColumn()
public final int	Returns: row number for the lower right hand corner getLastRow()
protected int	getMaxColumn()
protected int	getMaxRow()
protected int	getMinColumn()
protected int	getMinRow()
public int	Returns: the size of the range (number of cells in the area). getNumberOfCells()
public Set<CellRangeAddressBase.CellPosition>	Returns: set of `CellPosition`s occupied by the given coordinates. Empty if the coordinates are not in the range, never null. getPosition(int rowInd, int colInd) Useful for logic like table/range styling, where some elements apply based on relative position in a range.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	Returns: returns true if this range and other range have at least 1 cell in common intersects(CellRangeAddressBase a candidate cell range address to check for intersection with this range other) Determines whether or not this CellRangeAddress and the specified CellRangeAddress intersect.
public final boolean	isFullColumnRange()
public final boolean	isFullRowRange()
public boolean	Returns: True if the coordinates lie within the bounds, false otherwise. isInRange(int The row, 0-based. rowInd, int The column, 0-based. colInd) Determines if the given coordinates lie within the bounds of this range.
public boolean	Returns: True if the reference lies within the bounds, false otherwise. isInRange(CellReference the CellReference to check ref) Determines if the given `CellReference` lies within the bounds of this range.
public boolean	Returns: True if the reference lies within the bounds, false otherwise. isInRange(CellAddress the CellAddress to check ref) Determines if the given `CellAddress` lies within the bounds of this range.
public boolean	Returns: True if the cell lies within the bounds, false otherwise. isInRange(Cell the Cell to check cell) Determines if the given `Cell` lies within the bounds of this range.
public Iterator<CellAddress>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over the CellAddresses in this cell range in row-major order.
public final void	setFirstColumn(int column number for the upper left hand corner firstCol)
public final void	setFirstRow(int row number for the upper left hand corner firstRow)
public final void	setLastColumn(int column number for the lower right hand corner lastCol)
public final void	setLastRow(int row number for the lower right hand corner lastRow)
public Spliterator<CellAddress>	spliterator() Overrides default java.lang.Iterable.spliterator. Returns a spliterator over the CellAddresses in this cell range in row-major order.
public final String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	validate(SpreadsheetVersion the version of Excel to validate against ssVersion) Validate the range limits against the supplied version of Excel
private static void	validateColumn(int column, SpreadsheetVersion ssVersion) Runs a bounds check for column numbers
private static void	validateRow(int row, SpreadsheetVersion ssVersion) Runs a bounds check for row numbers

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

_firstCol	back to summary
private int _firstCol

_firstRow	back to summary
private int _firstRow

_lastCol	back to summary
private int _lastCol

_lastRow	back to summary
private int _lastRow

Constructor Detail

CellRangeAddressBase	back to summary
protected CellRangeAddressBase(int firstRow, int lastRow, int firstCol, int lastCol)

Method Detail

containsColumn	back to summary
public boolean containsColumn(int colInd) Check if the column is in the specified cell range Parameters colInd:int the column to check Returns:boolean true if the range contains the column [colInd]

containsColumn

back to summary

public boolean containsColumn(int colInd)

Check if the column is in the specified cell range

Parameters

colInd:int: the column to check

Returns:boolean

true if the range contains the column [colInd]

containsRow	back to summary
public boolean containsRow(int rowInd) Check if the row is in the specified cell range Parameters rowInd:int the row to check Returns:boolean true if the range contains the row [rowInd]

containsRow

back to summary

public boolean containsRow(int rowInd)

Check if the row is in the specified cell range

Parameters

rowInd:int: the row to check

Returns:boolean

true if the range contains the row [rowInd]

equals back to summary

equals	back to summary
public boolean equals(Object other) 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 other: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

public boolean equals(Object other)

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

other: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

getFirstColumn	back to summary
public final int getFirstColumn() Returns:int column number for the upper left hand corner

getFirstRow	back to summary
public final int getFirstRow() Returns:int row number for the upper left hand corner

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getLastColumn	back to summary
public final int getLastColumn() Returns:int column number for the lower right hand corner

getLastRow	back to summary
public final int getLastRow() Returns:int row number for the lower right hand corner

getMaxColumn	back to summary
protected int getMaxColumn()

getMaxRow	back to summary
protected int getMaxRow()

getMinColumn	back to summary
protected int getMinColumn()

getMinRow	back to summary
protected int getMinRow()

getNumberOfCells	back to summary
public int getNumberOfCells() Returns:int the size of the range (number of cells in the area).

getPosition back to summary

getPosition	back to summary
public Set<CellRangeAddressBase.CellPosition> getPosition(int rowInd, int colInd) Useful for logic like table/range styling, where some elements apply based on relative position in a range. Returns:Set<CellRangeAddressBase.CellPosition> set of `CellPosition`s occupied by the given coordinates. Empty if the coordinates are not in the range, never null. Since 3.17 beta 1

public Set<CellRangeAddressBase.CellPosition> getPosition(int rowInd, int colInd)

Useful for logic like table/range styling, where some elements apply based on relative position in a range.

Returns:Set<CellRangeAddressBase.CellPosition>: set of CellPositions occupied by the given coordinates. Empty if the coordinates are not in the range, never null.
Since: 3.17 beta 1

hashCode back to summary

hashCode	back to summary
public int hashCode() 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

public int hashCode()

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

intersects back to summary

intersects	back to summary
public boolean intersects(CellRangeAddressBase other) Determines whether or not this CellRangeAddress and the specified CellRangeAddress intersect. Parameters other:CellRangeAddressBase a candidate cell range address to check for intersection with this range Returns:boolean returns true if this range and other range have at least 1 cell in common See Also `for checking if a single cell intersects`

public boolean intersects(CellRangeAddressBase other)

Determines whether or not this CellRangeAddress and the specified CellRangeAddress intersect.

Parameters

other:CellRangeAddressBase: a candidate cell range address to check for intersection with this range

Returns:boolean

returns true if this range and other range have at least 1 cell in common

isFullColumnRange	back to summary
public final boolean isFullColumnRange()

isFullRowRange	back to summary
public final boolean isFullRowRange()

isInRange	back to summary
public boolean isInRange(int rowInd, int colInd) Determines if the given coordinates lie within the bounds of this range. Parameters rowInd:int The row, 0-based. colInd:int The column, 0-based. Returns:boolean True if the coordinates lie within the bounds, false otherwise. See Also {@link #intersects(CellRangeAddressBase)} for checking if two ranges overlap

isInRange

back to summary

public boolean isInRange(int rowInd, int colInd)

Determines if the given coordinates lie within the bounds of this range.

Parameters

rowInd:int: The row, 0-based.
colInd:int: The column, 0-based.

Returns:boolean

True if the coordinates lie within the bounds, false otherwise.

See Also

{@link #intersects(CellRangeAddressBase)} for checking if two ranges overlap

isInRange back to summary

isInRange	back to summary
public boolean isInRange(CellReference ref) Determines if the given `CellReference` lies within the bounds of this range. Note It is up to the caller to ensure the reference is for the correct sheet, since this instance doesn't have a sheet reference. Parameters ref:CellReference the CellReference to check Returns:boolean True if the reference lies within the bounds, false otherwise. See Also {@link #intersects(CellRangeAddressBase)} for checking if two ranges overlap

public boolean isInRange(CellReference ref)

Determines if the given CellReference lies within the bounds of this range.

Note

It is up to the caller to ensure the reference is for the correct sheet, since this instance doesn't have a sheet reference.

Parameters

ref:CellReference: the CellReference to check

Returns:boolean

True if the reference lies within the bounds, false otherwise.

See Also

{@link #intersects(CellRangeAddressBase)} for checking if two ranges overlap

isInRange back to summary

isInRange	back to summary
public boolean isInRange(CellAddress ref) Determines if the given `CellAddress` lies within the bounds of this range. Note It is up to the caller to ensure the reference is for the correct sheet, since this instance doesn't have a sheet reference. Parameters ref:CellAddress the CellAddress to check Returns:boolean True if the reference lies within the bounds, false otherwise. See Also {@link #intersects(CellRangeAddressBase)} for checking if two ranges overlap

public boolean isInRange(CellAddress ref)

Determines if the given CellAddress lies within the bounds of this range.

Note

It is up to the caller to ensure the reference is for the correct sheet, since this instance doesn't have a sheet reference.

Parameters

ref:CellAddress: the CellAddress to check

Returns:boolean

True if the reference lies within the bounds, false otherwise.

See Also

{@link #intersects(CellRangeAddressBase)} for checking if two ranges overlap

isInRange back to summary

isInRange	back to summary
public boolean isInRange(Cell cell) Determines if the given `Cell` lies within the bounds of this range. Note It is up to the caller to ensure the reference is for the correct sheet, since this instance doesn't have a sheet reference. Parameters cell:Cell the Cell to check Returns:boolean True if the cell lies within the bounds, false otherwise. See Also {@link #intersects(CellRangeAddressBase)} for checking if two ranges overlap

public boolean isInRange(Cell cell)

Determines if the given Cell lies within the bounds of this range.

Note

It is up to the caller to ensure the reference is for the correct sheet, since this instance doesn't have a sheet reference.

Parameters

cell:Cell: the Cell to check

Returns:boolean

True if the cell lies within the bounds, false otherwise.

See Also

{@link #intersects(CellRangeAddressBase)} for checking if two ranges overlap

iterator	back to summary
public Iterator<CellAddress> iterator() Implements java.lang.Iterable.iterator. Returns an iterator over the CellAddresses in this cell range in row-major order. Returns:Iterator<CellAddress> Doc from java.lang.Iterable.iterator. an Iterator. Annotations @Override Since POI 4.0.0

iterator

back to summary

public Iterator<CellAddress> iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator over the CellAddresses in this cell range in row-major order.

Returns:Iterator<CellAddress>

Doc from java.lang.Iterable.iterator.

an Iterator.

Annotations

@Override

Since

POI 4.0.0

setFirstColumn	back to summary
public final void setFirstColumn(int firstCol) Parameters firstCol:int column number for the upper left hand corner

setFirstRow	back to summary
public final void setFirstRow(int firstRow) Parameters firstRow:int row number for the upper left hand corner

setLastColumn	back to summary
public final void setLastColumn(int lastCol) Parameters lastCol:int column number for the lower right hand corner

setLastRow	back to summary
public final void setLastRow(int lastRow) Parameters lastRow:int row number for the lower right hand corner

spliterator back to summary

spliterator	back to summary
public Spliterator<CellAddress> spliterator() Overrides default java.lang.Iterable.spliterator. Returns a spliterator over the CellAddresses in this cell range in row-major order. Returns:Spliterator<CellAddress> Doc from java.lang.Iterable.spliterator. a `Spliterator` over the elements described by this `Iterable`. Annotations @Override Since POI 5.2.0

public Spliterator<CellAddress> spliterator()

Overrides default java.lang.Iterable.spliterator.

Returns a spliterator over the CellAddresses in this cell range in row-major order.

Returns:Spliterator<CellAddress>

Doc from java.lang.Iterable.spliterator.

a Spliterator over the elements described by this Iterable.

Annotations

@Override

Since

POI 5.2.0

toString back to summary

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

validate	back to summary
public void validate(SpreadsheetVersion ssVersion) Validate the range limits against the supplied version of Excel Parameters ssVersion:SpreadsheetVersion the version of Excel to validate against Exceptions IllegalArgumentException: if the range limits are outside of the allowed range

validate

back to summary

public void validate(SpreadsheetVersion ssVersion)

Validate the range limits against the supplied version of Excel

Parameters

ssVersion:SpreadsheetVersion: the version of Excel to validate against

Exceptions

IllegalArgumentException:: if the range limits are outside of the allowed range

validateColumn	back to summary
private static void validateColumn(int column, SpreadsheetVersion ssVersion) Runs a bounds check for column numbers

validateRow	back to summary
private static void validateRow(int row, SpreadsheetVersion ssVersion) Runs a bounds check for row numbers

org.apache.poi.ss.util back to summary

public final Enum CellRangeAddressBase.CellPosition

Class Inheritance

extends Enum<CellRangeAddressBase.CellPosition>

java.lang.Object
java.lang.Enum
org.apache.poi.ss.util.CellRangeAddressBase.CellPosition

Indicates a cell or range is in the given relative position in a range. More than one of these may apply at once.

Field Summary

Modifier and Type	Field and Description
public static final CellRangeAddressBase.CellPosition	BOTTOM range ending rows are equal
public static final CellRangeAddressBase.CellPosition	INSIDE a cell or range is completely inside another range, without touching any edges (a cell in this position can't be in any others)
public static final CellRangeAddressBase.CellPosition	LEFT range starting columns are equal
public static final CellRangeAddressBase.CellPosition	RIGHT range ending columns are equal
public static final CellRangeAddressBase.CellPosition	TOP range starting rows are equal

Constructor Summary

Access	Constructor and Description
private	CellPosition()

Method Summary

Modifier and Type	Method and Description
public static CellRangeAddressBase.CellPosition	valueOf(String name)
public static CellRangeAddressBase.CellPosition[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BOTTOM	back to summary
public static final CellRangeAddressBase.CellPosition BOTTOM range ending rows are equal

INSIDE	back to summary
public static final CellRangeAddressBase.CellPosition INSIDE a cell or range is completely inside another range, without touching any edges (a cell in this position can't be in any others)

LEFT	back to summary
public static final CellRangeAddressBase.CellPosition LEFT range starting columns are equal

RIGHT	back to summary
public static final CellRangeAddressBase.CellPosition RIGHT range ending columns are equal

TOP	back to summary
public static final CellRangeAddressBase.CellPosition TOP range starting rows are equal

Constructor Detail

CellPosition	back to summary
private CellPosition()

Method Detail

valueOf	back to summary
public static CellRangeAddressBase.CellPosition valueOf(String name)

values	back to summary
public static CellRangeAddressBase.CellPosition[] values()

org.apache.poi.ss.util back to summary

private Class CellRangeAddressBase.RowMajorCellAddressIterator

Class Inheritance

extends Object
implements Iterator<CellAddress>

java.lang.Object
org.apache.poi.ss.util.CellRangeAddressBase.RowMajorCellAddressIterator

All Implemented Interfaces

java.util.Iterator

Iterates over the cell addresses in a cell range in row major order The iterator is unaffected by changes to the CellRangeAddressBase instance after the iterator is created.

Field Summary

Modifier and Type	Field and Description
private int	c
private final int	firstCol
private final int	firstRow
private final int	lastCol
private final int	lastRow
private int	r

Constructor Summary

Access	Constructor and Description
public	RowMajorCellAddressIterator(CellRangeAddressBase ref)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public CellAddress	next() Implements java.util.Iterator.next. Returns the next element in the iteration.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

c	back to summary
private int c

firstCol	back to summary
private final int firstCol

firstRow	back to summary
private final int firstRow

lastCol	back to summary
private final int lastCol

lastRow	back to summary
private final int lastRow

r	back to summary
private int r

Constructor Detail

RowMajorCellAddressIterator	back to summary
public RowMajorCellAddressIterator(CellRangeAddressBase ref)

Method Detail

hasNext back to summary

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations