Browse Source

javadoc

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1895351 13f79535-47bb-0310-9956-ffa450edef68
tags/REL_5_2_0
PJ Fanning 2 years ago
parent
commit
29b3ad25df

+ 4
- 4
poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFCell.java View File

@@ -446,8 +446,8 @@ public class SXSSFCell extends CellBase {
/**
* Set a boolean value for the cell
*
* @param value the boolean value to set this cell to. For formulas we'll set the
* precalculated value, for booleans we'll set its value. For other types we
* @param value the boolean value to set this cell to. For formulas, we'll set the
* precalculated value, for booleans we'll set its value. For other types, we
* will change the cell to a boolean cell and set its value.
*/
@Override
@@ -463,9 +463,9 @@ public class SXSSFCell extends CellBase {
/**
* Set a error value for the cell
*
* @param value the error value to set this cell to. For formulas we'll set the
* @param value the error value to set this cell to. For formulas, we'll set the
* precalculated value , for errors we'll set
* its value. For other types we will change the cell to an error
* its value. For other types, we will change the cell to an error
* cell and set its value.
* @see org.apache.poi.ss.usermodel.FormulaError
*/

+ 6
- 6
poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFCell.java View File

@@ -212,8 +212,8 @@ public final class XSSFCell extends CellBase {
/**
* Set a boolean value for the cell
*
* @param value the boolean value to set this cell to. For formulas we'll set the
* precalculated value, for booleans we'll set its value. For other types we
* @param value the boolean value to set this cell to. For formulas, we'll set the
* precalculated value, for booleans we'll set its value. For other types, we
* will change the cell to a boolean cell and set its value.
*/
@Override
@@ -766,9 +766,9 @@ public final class XSSFCell extends CellBase {
/**
* Set a error value for the cell
*
* @param errorCode the error value to set this cell to. For formulas we'll set the
* @param errorCode the error value to set this cell to. For formulas, we'll set the
* precalculated value , for errors we'll set
* its value. For other types we will change the cell to an error
* its value. For other types, we will change the cell to an error
* cell and set its value.
* @see FormulaError
*/
@@ -781,9 +781,9 @@ public final class XSSFCell extends CellBase {
/**
* Set a error value for the cell
*
* @param error the error value to set this cell to. For formulas we'll set the
* @param error the error value to set this cell to. For formulas, we'll set the
* precalculated value , for errors we'll set
* its value. For other types we will change the cell to an error
* its value. For other types, we will change the cell to an error
* cell and set its value.
*/
public void setCellErrorValue(FormulaError error) {

+ 6
- 6
poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFCell.java View File

@@ -748,8 +748,8 @@ public class HSSFCell extends CellBase {
/**
* set a boolean value for the cell
*
* @param value the boolean value to set this cell to. For formulas we'll set the
* precalculated value, for booleans we'll set its value. For other types we
* @param value the boolean value to set this cell to. For formulas, we'll set the
* precalculated value, for booleans we'll set its value. For other types, we
* will change the cell to a boolean cell and set its value.
*/
@Override
@@ -775,9 +775,9 @@ public class HSSFCell extends CellBase {
/**
* set a error value for the cell
*
* @param errorCode the error value to set this cell to. For formulas we'll set the
* @param errorCode the error value to set this cell to. For formulas, we'll set the
* precalculated value , for errors we'll set
* its value. For other types we will change the cell to an error
* its value. For other types, we will change the cell to an error
* cell and set its value.
* For error code byte, see {@link FormulaError}.
* @deprecated 3.15 beta 2. Use {@link #setCellErrorValue(FormulaError)} instead.
@@ -791,9 +791,9 @@ public class HSSFCell extends CellBase {
/**
* set a error value for the cell
*
* @param error the error value to set this cell to. For formulas we'll set the
* @param error the error value to set this cell to. For formulas, we'll set the
* precalculated value , for errors we'll set
* its value. For other types we will change the cell to an error
* its value. For other types, we will change the cell to an error
* cell and set its value.
*/
@SuppressWarnings("fallthrough")

+ 18
- 18
poi/src/main/java/org/apache/poi/ss/usermodel/Cell.java View File

@@ -124,8 +124,8 @@ public interface Cell {
/**
* Set a numeric value for the cell.
*
* @param value the numeric value to set this cell to. For formulas we'll set the
* precalculated value, for numerics we'll set its value. For other types we
* @param value the numeric value to set this cell to. For formulas, we'll set the
* precalculated value, for numerics we'll set its value. For other types, we
* will change the cell to a numeric cell and set its value.
*/
void setCellValue(double value);
@@ -141,8 +141,8 @@ public interface Cell {
* does not attempt to replicate this behaviour. To make a numeric cell
* display as a date, use {@link #setCellStyle(CellStyle)} etc.</p>
*
* @param value the numeric value to set this cell to. For formulas we'll set the
* precalculated value, for numerics we'll set its value. For other types we
* @param value the numeric value to set this cell to. For formulas, we'll set the
* precalculated value, for numerics we'll set its value. For other types, we
* will change the cell to a numerics cell and set its value.
*/
void setCellValue(Date value);
@@ -158,8 +158,8 @@ public interface Cell {
* does not attempt to replicate this behaviour. To make a numeric cell
* display as a date, use {@link #setCellStyle(CellStyle)} etc.</p>
*
* @param value the numeric value to set this cell to. For formulas we'll set the
* precalculated value, for numerics we'll set its value. For other types we
* @param value the numeric value to set this cell to. For formulas, we'll set the
* precalculated value, for numerics we'll set its value. For other types, we
* will change the cell to a numerics cell and set its value.
*/
void setCellValue(LocalDateTime value);
@@ -175,8 +175,8 @@ public interface Cell {
* does not attempt to replicate this behaviour. To make a numeric cell
* display as a date, use {@link #setCellStyle(CellStyle)} etc.</p>
*
* @param value the numeric value to set this cell to. For formulas we'll set the
* precalculated value, for numerics we'll set its value. For other types we
* @param value the numeric value to set this cell to. For formulas, we'll set the
* precalculated value, for numerics we'll set its value. For other types, we
* will change the cell to a numerics cell and set its value.
*/
default void setCellValue(LocalDate value) {
@@ -195,8 +195,8 @@ public interface Cell {
* automatically shift the times to the default timezone.
* </p>
*
* @param value the date value to set this cell to. For formulas we'll set the
* precalculated value, for numerics we'll set its value. For othertypes we
* @param value the date value to set this cell to. For formulas, we'll set the
* precalculated value, for numerics we'll set its value. For other types, we
* will change the cell to a numeric cell and set its value.
*/
void setCellValue(Calendar value);
@@ -204,8 +204,8 @@ public interface Cell {
/**
* Set a rich string value for the cell.
*
* @param value value to set the cell to. For formulas we'll set the formula
* string, for String cells we'll set its value. For other types we will
* @param value value to set the cell to. For formulas, we'll set the formula
* string, for String cells we'll set its value. For other types, we will
* change the cell to a string cell and set its value.
* If value is null then we will change the cell to a Blank cell.
*/
@@ -214,8 +214,8 @@ public interface Cell {
/**
* Set a string value for the cell.
*
* @param value value to set the cell to. For formulas we'll set the formula
* string, for String cells we'll set its value. For other types we will
* @param value value to set the cell to. For formulas, we'll set the formula
* string, for String cells we'll set its value. For other types, we will
* change the cell to a string cell and set its value.
* If value is null then we will change the cell to a Blank cell.
*/
@@ -319,8 +319,8 @@ public interface Cell {
/**
* Set a boolean value for the cell
*
* @param value the boolean value to set this cell to. For formulas we'll set the
* precalculated value, for booleans we'll set its value. For other types we
* @param value the boolean value to set this cell to. For formulas, we'll set the
* precalculated value, for booleans we'll set its value. For other types, we
* will change the cell to a boolean cell and set its value.
*/
void setCellValue(boolean value);
@@ -328,9 +328,9 @@ public interface Cell {
/**
* Set a error value for the cell
*
* @param value the error value to set this cell to. For formulas we'll set the
* @param value the error value to set this cell to. For formulas, we'll set the
* precalculated value , for errors we'll set
* its value. For other types we will change the cell to an error
* its value. For other types, we will change the cell to an error
* cell and set its value.
* @see FormulaError
*/

Loading…
Cancel
Save