import org.apache.poi.ss.util.SheetUtil;
import org.apache.poi.util.Internal;
import org.apache.poi.util.NotImplemented;
+import org.apache.poi.util.Removal;
import org.apache.poi.xssf.usermodel.XSSFColor;
import org.apache.poi.xssf.usermodel.XSSFComment;
import org.apache.poi.xssf.usermodel.XSSFDataValidation;
/**
* Gets the user model for the default document header.
- * <p/>
+ * <p>
* Note that XSSF offers more kinds of document headers than HSSF does
* </p>
* @return the document header. Never <code>null</code>
/**
* Gets the user model for the default document footer.
- * <p/>
+ * <p>
* Note that XSSF offers more kinds of document footers than HSSF does.
- *
+ * </p>
* @return the document footer. Never <code>null</code>
*/
@Override
/**
* Sets a flag indicating whether this sheet is selected.
- *<p>
* Note: multiple sheets can be selected, but only one sheet can be active at one time.
- *</p>
+ * </p>
* @param value <code>true</code> if this sheet is selected
* @see Workbook#setActiveSheet(int)
*/
/**
* Answer whether protection is enabled or disabled
*
- * @return true => protection enabled; false => protection disabled
+ * @return true means protection enabled; false means protection disabled
*/
@Override
public boolean getProtect()
/**
* Answer whether scenario protection is enabled or disabled
*
- * @return true => protection enabled; false => protection disabled
+ * @return true means protection enabled; false means protection disabled
*/
@Override
public boolean getScenarioProtect()
}
/**
- * Sets the zoom magnication for the sheet. The zoom is expressed as a
+ * Sets the zoom magnification for the sheet. The zoom is expressed as a
* fraction. For example to express a zoom of 75% use 3 for the numerator
* and 4 for the denominator.
*
* @param denominator The denominator for the zoom magnification.
* @deprecated 2015-11-23 (circa POI 3.14beta1). Use {@link #setZoom(int)} instead.
*/
+ @Removal(version="3.16")
@Override
public void setZoom(int numerator, int denominator)
{
/**
* Window zoom magnification for current view representing percent values.
- * Valid values range from 10 to 400. Horizontal & Vertical scale together.
+ * Valid values range from 10 to 400. Horizontal and Vertical scale together.
*
* For example:
* <pre>
* </p>
*
* @param rownum index of row to update (0-based)
- * @param level outline level (> 0)
+ * @param level outline level (greater than 0)
*/
public void setRowOutlineLevel(int rownum, int level)
{
*/
public class SXSSFWorkbook implements Workbook {
/**
- * Specifies how many rows can be accessed at most via getRow().
- * When a new node is created via createRow() and the total number
+ * Specifies how many rows can be accessed at most via {@link SXSSFSheet#getRow}.
+ * When a new node is created via {@link SXSSFSheet#createRow} and the total number
* of unflushed records would exceed the specified value, then the
* row with the lowest index value is flushed and cannot be accessed
- * via getRow() anymore.
+ * via {@link SXSSFSheet#getRow} anymore.
*/
public static final int DEFAULT_WINDOW_SIZE = 100;
private static final POILogger logger = POILogFactory.getLogger(SXSSFWorkbook.class);
}
/**
- * Construct a workbook from a template.
- * <p>
+ * <p>Construct a workbook from a template.</p>
+ *
* There are three use-cases to use SXSSFWorkbook(XSSFWorkbook) :
* <ol>
* <li>
* </li>
* <li>
* Append rows to existing sheets. The row number MUST be greater
- * than max(rownum) in the template sheet.
+ * than {@code max(rownum)} in the template sheet.
* </li>
* <li>
* Use existing workbook as a template and re-use global objects such
* </li>
* </ol>
* All three use cases can work in a combination.
- * </p>
+ *
* What is not supported:
* <ul>
* <li>
* Access initial cells and rows in the template. After constructing
- * SXSSFWorkbook(XSSFWorkbook) all internal windows are empty and
- * SXSSFSheet@getRow and SXSSFRow#getCell return null.
+ * {@link #SXSSFWorkbook(XSSFWorkbook)} all internal windows are empty and
+ * {@link SXSSFSheet#getRow} and {@link SXSSFRow#getCell} return <code>null</code>.
* </li>
* <li>
* Override existing cells and rows. The API silently allows that but
/**
* Constructs an workbook from an existing workbook.
* <p>
- * When a new node is created via createRow() and the total number
+ * When a new node is created via {@link SXSSFSheet#createRow} and the total number
* of unflushed records would exceed the specified value, then the
* row with the lowest index value is flushed and cannot be accessed
- * via getRow() anymore.
+ * via {@link SXSSFSheet#getRow} anymore.
* </p>
* <p>
- * A value of -1 indicates unlimited access. In this case all
- * records that have not been flushed by a call to flush() are available
+ * A value of <code>-1</code> indicates unlimited access. In this case all
+ * records that have not been flushed by a call to <code>flush()</code> are available
* for random access.
+ * </p>
* <p>
- * <p></p>
- * A value of 0 is not allowed because it would flush any newly created row
+ * A value of <code>0</code> is not allowed because it would flush any newly created row
* without having a chance to specify any cells.
* </p>
*
/**
* Constructs an workbook from an existing workbook.
* <p>
- * When a new node is created via createRow() and the total number
+ * When a new node is created via {@link SXSSFSheet#createRow} and the total number
* of unflushed records would exceed the specified value, then the
* row with the lowest index value is flushed and cannot be accessed
- * via getRow() anymore.
+ * via {@link SXSSFSheet#getRow} anymore.
* </p>
* <p>
- * A value of -1 indicates unlimited access. In this case all
- * records that have not been flushed by a call to flush() are available
+ * A value of <code>-1</code> indicates unlimited access. In this case all
+ * records that have not been flushed by a call to <code>flush()</code> are available
* for random access.
+ * </p>
* <p>
- * <p></p>
- * A value of 0 is not allowed because it would flush any newly created row
+ * A value of <code>0</code> is not allowed because it would flush any newly created row
* without having a chance to specify any cells.
* </p>
*
/**
* Constructs an workbook from an existing workbook.
* <p>
- * When a new node is created via createRow() and the total number
+ * When a new node is created via {@link SXSSFSheet#createRow} and the total number
* of unflushed records would exceed the specified value, then the
* row with the lowest index value is flushed and cannot be accessed
- * via getRow() anymore.
+ * via {@link SXSSFSheet#getRow} anymore.
* </p>
* <p>
- * A value of -1 indicates unlimited access. In this case all
- * records that have not been flushed by a call to flush() are available
+ * A value of <code>-1</code> indicates unlimited access. In this case all
+ * records that have not been flushed by a call to <code>flush()</code> are available
* for random access.
+ * </p>
* <p>
- * <p></p>
- * A value of 0 is not allowed because it would flush any newly created row
+ * A value of <code>0</code> is not allowed because it would flush any newly created row
* without having a chance to specify any cells.
* </p>
*
/**
* Construct an empty workbook and specify the window for row access.
* <p>
- * When a new node is created via createRow() and the total number
+ * When a new node is created via {@link SXSSFSheet#createRow} and the total number
* of unflushed records would exceed the specified value, then the
* row with the lowest index value is flushed and cannot be accessed
- * via getRow() anymore.
+ * via {@link SXSSFSheet#getRow} anymore.
* </p>
* <p>
- * A value of -1 indicates unlimited access. In this case all
- * records that have not been flushed by a call to flush() are available
+ * A value of <code>-1</code> indicates unlimited access. In this case all
+ * records that have not been flushed by a call to <code>flush()</code> are available
* for random access.
+ * </p>
* <p>
- * <p></p>
- * A value of 0 is not allowed because it would flush any newly created row
+ * A value of <code>0</code> is not allowed because it would flush any newly created row
* without having a chance to specify any cells.
* </p>
*
/**
* Get the Sheet object at the given index.
*
- * @param index of the sheet number (0-based physical & logical)
+ * @param index of the sheet number (0-based physical and logical)
* @return Sheet at the provided index
*/
@Override
}
/**
- * Gets the defined name index by name<br/>
+ * Gets the defined name index by name
+ *
* <i>Note:</i> Excel defined names are case-insensitive and
* this method performs a case-insensitive search.
*
* @param name the name of the defined name
- * @return zero based index of the defined name. <tt>-1</tt> if not found.
+ * @return zero based index of the defined name. <code>-1</code> if not found.
*/
@Override
public int getNameIndex(String name)
projects / poi.git / commitdiff