diff options
| -rw-r--r-- | src/java/org/apache/poi/ss/usermodel/CellRange.java | 68 |
1 files changed, 33 insertions, 35 deletions
diff --git a/src/java/org/apache/poi/ss/usermodel/CellRange.java b/src/java/org/apache/poi/ss/usermodel/CellRange.java index 9c25f870c1..4868dd8e81 100644 --- a/src/java/org/apache/poi/ss/usermodel/CellRange.java +++ b/src/java/org/apache/poi/ss/usermodel/CellRange.java @@ -22,50 +22,48 @@ import java.util.Iterator; /** * Represents a rectangular region of a {@link Sheet} - * - * @author Josh Micich */ public interface CellRange<C extends Cell> extends Iterable<C> { + int getWidth(); + int getHeight(); - int getWidth(); - int getHeight(); - /** - * Gets the number of cells in this range. - * @return <tt>height * width </tt> - */ - int size(); + /** + * Gets the number of cells in this range. + * @return <tt>height * width </tt> + */ + int size(); /** * @return the text format of this range. Single cell ranges are formatted * like single cell references (e.g. 'A1' instead of 'A1:A1'). */ - String getReferenceText(); + String getReferenceText(); - /** - * @return the cell at relative coordinates (0,0). Never <code>null</code>. - */ - C getTopLeftCell(); + /** + * @return the cell at relative coordinates (0,0). Never <code>null</code>. + */ + C getTopLeftCell(); - /** - * @param relativeRowIndex must be between <tt>0</tt> and <tt>height-1</tt> - * @param relativeColumnIndex must be between <tt>0</tt> and <tt>width-1</tt> - * @return the cell at the specified coordinates. Never <code>null</code>. - */ - C getCell(int relativeRowIndex, int relativeColumnIndex); - /** - * @return a flattened array of all the cells in this {@link CellRange} - */ - C[] getFlattenedCells(); - /** - * @return a 2-D array of all the cells in this {@link CellRange}. The first - * array dimension is the row index (values <tt>0...height-1</tt>) - * and the second dimension is the column index (values <tt>0...width-1</tt>) - */ - C[][] getCells(); + /** + * @param relativeRowIndex must be between <tt>0</tt> and <tt>height-1</tt> + * @param relativeColumnIndex must be between <tt>0</tt> and <tt>width-1</tt> + * @return the cell at the specified coordinates. Never <code>null</code>. + */ + C getCell(int relativeRowIndex, int relativeColumnIndex); + /** + * @return a flattened array of all the cells in this {@link CellRange} + */ + C[] getFlattenedCells(); + /** + * @return a 2-D array of all the cells in this {@link CellRange}. The first + * array dimension is the row index (values <tt>0...height-1</tt>) + * and the second dimension is the column index (values <tt>0...width-1</tt>) + */ + C[][] getCells(); - /** - * @return an {@link Iterator} over all cells in this range. Iteration starts - * with all cells in the first row followed by all cells in the next row, etc. - */ - Iterator<C> iterator(); + /** + * @return an {@link Iterator} over all cells in this range. Iteration starts + * with all cells in the first row followed by all cells in the next row, etc. + */ + Iterator<C> iterator(); } |