Add a note on how this is not the right way to make a string of your cell

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1632438 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2014-10-16 21:41:11 +00:00
parent 860892e68d
commit aa6ea5344b
1 changed files with 7 additions and 2 deletions

View File

@ -110,8 +110,13 @@ public interface Cell {
/**
* Set the cells type (numeric, formula or string).
* If the cell currently contains a value, the value will
* be converted to match the new type, if possible.
* <p>If the cell currently contains a value, the value will
* be converted to match the new type, if possible. Formatting
* is generally lost in the process however.</p>
* <p>If what you want to do is get a String value for your
* numeric cell, <i>stop!</i>. This is not the way to do it.
* Instead, for fetching the string value of a numeric or boolean
* or date cell, use {@link DataFormatter} instead.</p>
*
* @throws IllegalArgumentException if the specified cell type is invalid
* @throws IllegalStateException if the current value cannot be converted to the new type