removed unused imports of deprecated classes, fixed javadoc errors

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@764203 13f79535-47bb-0310-9956-ffa450edef68

23 files changed, 38 insertions, 40 deletions

diff --git a/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableModel.java b/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableModel.java
index 54c8d96362..c2f4bb31a0 100644
--- a/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableModel.java
+++ b/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableModel.java
@@ -61,7 +61,7 @@ public class SVTableModel extends AbstractTableModel {
     HSSFRow r = st.getRow(row);
     HSSFCell c = null;
     if (r != null) {
-      c = r.getCell((short)col);
+      c = r.getCell(col);
     }
     return c;
   }
diff --git a/src/java/org/apache/poi/hssf/dev/HSSF.java b/src/java/org/apache/poi/hssf/dev/HSSF.java
index fc1cd3880e..c714255f0b 100644
--- a/src/java/org/apache/poi/hssf/dev/HSSF.java
+++ b/src/java/org/apache/poi/hssf/dev/HSSF.java
@@ -31,7 +31,6 @@ import org.apache.poi.hssf.usermodel.HSSFSheet;
 import org.apache.poi.hssf.usermodel.HSSFWorkbook;
 import org.apache.poi.ss.util.CellRangeAddress;
 import org.apache.poi.poifs.filesystem.POIFSFileSystem;
-import org.apache.poi.ss.util.Region;
 
 /**
  * File for HSSF testing/examples
diff --git a/src/java/org/apache/poi/hssf/extractor/EventBasedExcelExtractor.java b/src/java/org/apache/poi/hssf/extractor/EventBasedExcelExtractor.java
index 430dcd4758..541295f216 100644
--- a/src/java/org/apache/poi/hssf/extractor/EventBasedExcelExtractor.java
+++ b/src/java/org/apache/poi/hssf/extractor/EventBasedExcelExtractor.java
@@ -57,9 +57,12 @@ import org.apache.poi.poifs.filesystem.POIFSFileSystem;
  * Returns the textual content of the file, suitable for
  *  indexing by something like Lucene, but not really
  *  intended for display to the user.
+ * <p>
  * To turn an excel file into a CSV or similar, then see
  *  the XLS2CSVmra example
- * @see org.apache.poi.hssf.eventusermodel.examples.XLS2CSVmra
+ * </p>
+ * <link href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/hssf/eventusermodel/examples/XLS2CSVmra.java">
+ * http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/hssf/eventusermodel/examples/XLS2CSVmra.java</link>
  */
 public class EventBasedExcelExtractor extends POIOLE2TextExtractor {
 	private POIFSFileSystem fs;
diff --git a/src/java/org/apache/poi/hssf/extractor/ExcelExtractor.java b/src/java/org/apache/poi/hssf/extractor/ExcelExtractor.java
index 8bed591c8a..e9a7130998 100644
--- a/src/java/org/apache/poi/hssf/extractor/ExcelExtractor.java
+++ b/src/java/org/apache/poi/hssf/extractor/ExcelExtractor.java
@@ -37,12 +37,17 @@ import org.apache.poi.ss.usermodel.HeaderFooter;
 
 /**
  * A text extractor for Excel files.
+ * <p>
  * Returns the textual content of the file, suitable for 
  *  indexing by something like Lucene, but not really
  *  intended for display to the user.
+ * </p>
+ * <p>
  * To turn an excel file into a CSV or similar, then see
  *  the XLS2CSVmra example
- * @see org.apache.poi.hssf.eventusermodel.examples.XLS2CSVmra
+ * </p>
+ * <link href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/hssf/eventusermodel/examples/XLS2CSVmra.java">
+ * http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/hssf/eventusermodel/examples/XLS2CSVmra.java</link>
  */
 public class ExcelExtractor extends POIOLE2TextExtractor implements org.apache.poi.ss.extractor.ExcelExtractor {
 	private HSSFWorkbook _wb;
diff --git a/src/java/org/apache/poi/hssf/model/Workbook.java b/src/java/org/apache/poi/hssf/model/Workbook.java
index 60e33c2f8e..4378779cc4 100644
--- a/src/java/org/apache/poi/hssf/model/Workbook.java
+++ b/src/java/org/apache/poi/hssf/model/Workbook.java
@@ -912,7 +912,7 @@ public final class Workbook implements Model {
     /**
      * use this function to add a Shared String Table to an existing sheet (say
      * generated by a different java api) without an sst....
-     * @see #createSST()
+     * @see #createExtendedSST()
      * @see org.apache.poi.hssf.record.SSTRecord
      */
 
diff --git a/src/java/org/apache/poi/hssf/package.html b/src/java/org/apache/poi/hssf/package.html
index a7dd31667c..b8d8b61326 100755
--- a/src/java/org/apache/poi/hssf/package.html
+++ b/src/java/org/apache/poi/hssf/package.html
@@ -31,8 +31,5 @@ For overviews, tutorials, examples, guides, and tool documentation, please see:
 <li><a href="http://poi.apache.org">Apache POI Project</a>
 </ul>
 
-<!-- Put @see and @since tags down here. -->
-@see org.apache.poi.poifs
-@see org.apache.poi.hpsf
 </body>
 </html>
diff --git a/src/java/org/apache/poi/hssf/record/CFRuleRecord.java b/src/java/org/apache/poi/hssf/record/CFRuleRecord.java
index cfaa991e62..040b45c297 100644
--- a/src/java/org/apache/poi/hssf/record/CFRuleRecord.java
+++ b/src/java/org/apache/poi/hssf/record/CFRuleRecord.java
@@ -438,9 +438,7 @@ public final class CFRuleRecord extends StandardRecord {
 	 * Subclasses should implement this so that their data is passed back in a
 	 * byte array.
 	 *
-	 * @param pOffset to begin writing at
-	 * @param data byte array containing instance data
-	 * @return number of bytes written
+	 * @param out the stream to write to
 	 */
 	public void serialize(LittleEndianOutput out) {
 		
diff --git a/src/java/org/apache/poi/hssf/record/DVALRecord.java b/src/java/org/apache/poi/hssf/record/DVALRecord.java
index 4186414447..a9559fa6a1 100644
--- a/src/java/org/apache/poi/hssf/record/DVALRecord.java
+++ b/src/java/org/apache/poi/hssf/record/DVALRecord.java
@@ -57,21 +57,21 @@ public final class DVALRecord extends StandardRecord {
 	}
 
     /**
-	 * @param field_1_options the options of the dialog
+	 * @param options the options of the dialog
 	 */
 	public void setOptions(short options) {
 		field_1_options = options;
 	}
 
 	/**
-	 * @param field_2_horiz_pos the Horizontal position of the dialog
+	 * @param horiz_pos the Horizontal position of the dialog
 	 */
 	public void setHorizontalPos(int horiz_pos) {
 		field_2_horiz_pos = horiz_pos;
 	}
 
 	/**
-	 * @param field_3_vert_pos the Vertical position of the dialog
+	 * @param vert_pos the Vertical position of the dialog
 	 */
 	public void setVerticalPos(int vert_pos) {
 		field_3_vert_pos = vert_pos;
diff --git a/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java b/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java
index f5fe5df32a..1111e99a27 100644
--- a/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java
+++ b/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java
@@ -28,8 +28,6 @@ import org.apache.poi.util.LittleEndianOutput;
  * REFERENCE:  PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
  * @author Andrew C. Oliver (acoliver at apache dot org)
  * @author Jason Height (jheight at apache dot org)
- *
- * @see org.apache.poi.hssf.record.ExtSSTInfoSubRecord
  */
 public final class ExtSSTRecord extends StandardRecord {
     public final static short sid = 0x00FF;
diff --git a/src/java/org/apache/poi/hssf/record/RecordBase.java b/src/java/org/apache/poi/hssf/record/RecordBase.java
index 6314eb0578..3a004049dc 100644
--- a/src/java/org/apache/poi/hssf/record/RecordBase.java
+++ b/src/java/org/apache/poi/hssf/record/RecordBase.java
@@ -18,7 +18,7 @@
 package org.apache.poi.hssf.record;
 
 /**
- * Common base class of {@link Record} and {@link RecordAggregate}
+ * Common base class of {@link Record} and {@link org.apache.poi.hssf.record.aggregates.RecordAggregate}
  * 
  * @author Josh Micich
  */
diff --git a/src/java/org/apache/poi/hssf/record/StandardRecord.java b/src/java/org/apache/poi/hssf/record/StandardRecord.java
index d26f11a10b..20fe141054 100644
--- a/src/java/org/apache/poi/hssf/record/StandardRecord.java
+++ b/src/java/org/apache/poi/hssf/record/StandardRecord.java
@@ -51,7 +51,7 @@ public abstract class StandardRecord extends Record {
 	 * Write the data content of this BIFF record.  The 'ushort sid' and 'ushort size' header fields

 	 * have already been written by the superclass.<br/>

 	 * 

-	 * The subclass must write the exact number of bytes as reported by {@link Record#getDataSize()}

+	 * The subclass must write the exact number of bytes as reported by {@link org.apache.poi.hssf.record.Record#getRecordSize()}}

 	 */

 	protected abstract void serialize(LittleEndianOutput out);

 }

diff --git a/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java b/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java
index 7619f49804..6a1e1b1505 100644
--- a/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java
+++ b/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java
@@ -35,7 +35,7 @@ import org.apache.poi.ss.usermodel.Workbook;
 /**

  * An alternative workbook evaluator that saves memory in situations where a single workbook is

  * concurrently and independently evaluated many times.  With standard formula evaluation, around 

- * 90% of memory consumption is due to loading of the {@link HSSFWorkbook} or {@link XSSFWorkbook}.

+ * 90% of memory consumption is due to loading of the {@link HSSFWorkbook} or {@link org.apache.poi.xssf.usermodel.XSSFWorkbook}.

  * This class enables a 'master workbook' to be loaded just once and shared between many evaluation

  * clients.  Each evaluation client creates its own {@link ForkedEvaluator} and can set cell values

  * that will be used for local evaluations (and don't disturb evaluations on other evaluators).

diff --git a/src/ooxml/java/org/apache/poi/POIXMLDocument.java b/src/ooxml/java/org/apache/poi/POIXMLDocument.java
index f71ed7ba3e..03a9466d9d 100644
--- a/src/ooxml/java/org/apache/poi/POIXMLDocument.java
+++ b/src/ooxml/java/org/apache/poi/POIXMLDocument.java
@@ -26,7 +26,6 @@ import org.apache.xmlbeans.XmlException;
 import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
 import org.apache.poi.openxml4j.exceptions.OpenXML4JException;
 import org.apache.poi.openxml4j.opc.*;
-import org.apache.poi.openxml4j.opc.Package;
 
 public abstract class POIXMLDocument extends POIXMLDocumentPart{
 
diff --git a/src/ooxml/java/org/apache/poi/POIXMLDocumentPart.java b/src/ooxml/java/org/apache/poi/POIXMLDocumentPart.java
index a93215a3b9..09030222c2 100755
--- a/src/ooxml/java/org/apache/poi/POIXMLDocumentPart.java
+++ b/src/ooxml/java/org/apache/poi/POIXMLDocumentPart.java
@@ -25,7 +25,6 @@ import org.apache.poi.util.POILogger;
 import org.apache.poi.util.POILogFactory;
 import org.apache.poi.openxml4j.exceptions.OpenXML4JException;
 import org.apache.poi.openxml4j.opc.*;
-import org.apache.poi.openxml4j.opc.Package;
 
 /**
  * Represents an entry of a OOXML package.
diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/Package.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/Package.java
index 0a41045614..bedc9b86d5 100755
--- a/src/ooxml/java/org/apache/poi/openxml4j/opc/Package.java
+++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/Package.java
@@ -90,7 +90,7 @@ public abstract class Package extends OPCPackage {
 	}
 
 	/**
-	 * @deprecated use {@link OPCPackage#open(File)} 
+	 * @deprecated use {@link OPCPackage#openOrCreate(java.io.File)}  
 	 */
 	public static Package openOrCreate(File file) throws InvalidFormatException {
 		Package retPackage = null;
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
index 2f2aa4945c..297120d228 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
@@ -640,7 +640,7 @@ public class XWPFParagraph {
      * paragraph in the document in absolute units.
      *
      * @return bigInteger - value representing the spacing after the paragraph
-     * @see #setSpacingAfterLines(BigInteger)
+     * @see #setSpacingAfterLines(int) 
      */
     public int getSpacingAfterLines() {
         CTSpacing spacing = getCTSpacing(false);
@@ -669,7 +669,7 @@ public class XWPFParagraph {
      * paragraph in the document in absolute units.
      *
      * @return the spacing that should be added above the first line
-     * @see #setSpacingBefore(BigInteger)
+     * @see #setSpacingBefore(int)
      */
     public int getSpacingBefore() {
         CTSpacing spacing = getCTSpacing(false);
@@ -700,7 +700,7 @@ public class XWPFParagraph {
      * The value of this attribute is specified in one hundredths of a line.
      *
      * @return the spacing that should be added before the first line in this paragraph
-     * @see #setSpacingBeforeLines(BigInteger)
+     * @see #setSpacingBeforeLines(int)
      */
     public int getSpacingBeforeLines() {
         CTSpacing spacing = getCTSpacing(false);
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
index 3c9e9c2c52..e1940bd1f9 100755
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
@@ -407,7 +407,7 @@ public class XWPFRun {
      * A break is a special character which is used to override the
      * normal line breaking that would be performed based on the normal layout
      * of the document's contents. 
-     * @see addCarriageReturn()
+     * @see #addCarriageReturn() 
      */
     public void addBreak() {
 	run.addNewBr();
diff --git a/src/scratchpad/src/org/apache/poi/hslf/model/Shape.java b/src/scratchpad/src/org/apache/poi/hslf/model/Shape.java
index ec6435d702..7ab1254370 100644
--- a/src/scratchpad/src/org/apache/poi/hslf/model/Shape.java
+++ b/src/scratchpad/src/org/apache/poi/hslf/model/Shape.java
@@ -34,7 +34,7 @@ import java.awt.geom.Rectangle2D;
  *  </p>
  *  <p>
  *  When you add a shape, you usually specify the dimensions of the shape and the position
- *  of the upper�left corner of the bounding box for the shape relative to the upper�left
+ *  of the upper'left corner of the bounding box for the shape relative to the upper'left
  *  corner of the page, worksheet, or slide. Distances in the drawing layer are measured
  *  in points (72 points = 1 inch).
  *  </p>
diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/PicturesTable.java b/src/scratchpad/src/org/apache/poi/hwpf/model/PicturesTable.java
index af9f5e8fb0..5aeb788e95 100644
--- a/src/scratchpad/src/org/apache/poi/hwpf/model/PicturesTable.java
+++ b/src/scratchpad/src/org/apache/poi/hwpf/model/PicturesTable.java
@@ -35,8 +35,8 @@ import org.apache.poi.ddf.EscherRecordFactory;
 
 /**
  * Holds information about all pictures embedded in Word Document either via "Insert -> Picture -> From File" or via
- * clipboard. Responsible for images extraction and determining whether some document�s piece contains embedded image.
- * Analyzes raw data bytestream �Data� (where Word stores all embedded objects) provided by HWPFDocument.
+ * clipboard. Responsible for images extraction and determining whether some document's piece contains embedded image.
+ * Analyzes raw data bytestream 'Data' (where Word stores all embedded objects) provided by HWPFDocument.
  *
  * Word stores images as is within so called "Data stream" - the stream within a Word docfile containing various data
  * that hang off of characters in the main stream. For example, binary data describing in-line pictures and/or
diff --git a/src/scratchpad/testcases/org/apache/poi/hslf/model/TestOleEmbedding.java b/src/scratchpad/testcases/org/apache/poi/hslf/model/TestOleEmbedding.java
index ae6f752ab2..9d0288c752 100644
--- a/src/scratchpad/testcases/org/apache/poi/hslf/model/TestOleEmbedding.java
+++ b/src/scratchpad/testcases/org/apache/poi/hslf/model/TestOleEmbedding.java
@@ -73,11 +73,11 @@ public final class TestOleEmbedding extends TestCase {
                     HSSFWorkbook wb = new HSSFWorkbook(data.getData());

                     HSSFSheet sheet = wb.getSheetAt(0);

                     //verify we can access the xls data

-                    assertEquals(1, sheet.getRow(0).getCell((short)0).getNumericCellValue(), 0);

-                    assertEquals(1, sheet.getRow(1).getCell((short)0).getNumericCellValue(), 0);

-                    assertEquals(2, sheet.getRow(2).getCell((short)0).getNumericCellValue(), 0);

-                    assertEquals(3, sheet.getRow(3).getCell((short)0).getNumericCellValue(), 0);

-                    assertEquals(8, sheet.getRow(5).getCell((short)0).getNumericCellValue(), 0);

+                    assertEquals(1, sheet.getRow(0).getCell(0).getNumericCellValue(), 0);

+                    assertEquals(1, sheet.getRow(1).getCell(0).getNumericCellValue(), 0);

+                    assertEquals(2, sheet.getRow(2).getCell(0).getNumericCellValue(), 0);

+                    assertEquals(3, sheet.getRow(3).getCell(0).getNumericCellValue(), 0);

+                    assertEquals(8, sheet.getRow(5).getCell(0).getNumericCellValue(), 0);

                 } else if ("Document".equals(ole.getInstanceName())){

                     //creating a HWPF document 

                     HWPFDocument doc = new HWPFDocument(data.getData());

diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestFormulas.java b/src/testcases/org/apache/poi/hssf/usermodel/TestFormulas.java
index c38a555edd..3281b5115a 100644
--- a/src/testcases/org/apache/poi/hssf/usermodel/TestFormulas.java
+++ b/src/testcases/org/apache/poi/hssf/usermodel/TestFormulas.java
@@ -859,7 +859,7 @@ public final class TestFormulas extends TestCase {
     public void test27272_1() throws Exception {
         HSSFWorkbook wb = openSample("27272_1.xls");
         wb.getSheetAt(0);
-        assertEquals("Reference for named range ", "Compliance!#REF!",wb.getNameAt(0).getReference());
+        assertEquals("Reference for named range ", "Compliance!#REF!",wb.getNameAt(0).getRefersToFormula());
         File outF = File.createTempFile("bug27272_1",".xls");
         wb.write(new FileOutputStream(outF));
         System.out.println("Open "+outF.getAbsolutePath()+" in Excel");
@@ -867,7 +867,7 @@ public final class TestFormulas extends TestCase {
     /** Unknown Ptg 3D*/
     public void test27272_2() throws Exception {
         HSSFWorkbook wb = openSample("27272_2.xls");
-        assertEquals("Reference for named range ", "LOAD.POD_HISTORIES!#REF!",wb.getNameAt(0).getReference());
+        assertEquals("Reference for named range ", "LOAD.POD_HISTORIES!#REF!",wb.getNameAt(0).getRefersToFormula());
         File outF = File.createTempFile("bug27272_2",".xls");
         wb.write(new FileOutputStream(outF));
         System.out.println("Open "+outF.getAbsolutePath()+" in Excel");
diff --git a/src/testcases/org/apache/poi/hssf/util/TestAreaReference.java b/src/testcases/org/apache/poi/hssf/util/TestAreaReference.java
index 2de4c9c1ca..4a15ac0eee 100644
--- a/src/testcases/org/apache/poi/hssf/util/TestAreaReference.java
+++ b/src/testcases/org/apache/poi/hssf/util/TestAreaReference.java
@@ -230,11 +230,11 @@ public final class TestAreaReference extends TestCase {
         HSSFName aNamedCell = wb.getNameAt(idx);
 
         // Should have 2 references
-        assertEquals(ref, aNamedCell.getReference());
+        assertEquals(ref, aNamedCell.getRefersToFormula());
 
         // Check the parsing of the reference into cells
-        assertFalse(AreaReference.isContiguous(aNamedCell.getReference()));
-        AreaReference[] arefs = AreaReference.generateContiguous(aNamedCell.getReference());
+        assertFalse(AreaReference.isContiguous(aNamedCell.getRefersToFormula()));
+        AreaReference[] arefs = AreaReference.generateContiguous(aNamedCell.getRefersToFormula());
         assertEquals(2, arefs.length);
         assertEquals(refA, arefs[0].formatAsString());
         assertEquals(refB, arefs[1].formatAsString());
diff --git a/src/testcases/org/apache/poi/ss/formula/FormulaParserTestHelper.java b/src/testcases/org/apache/poi/ss/formula/FormulaParserTestHelper.java
index 144002279d..9ed63390d2 100644
--- a/src/testcases/org/apache/poi/ss/formula/FormulaParserTestHelper.java
+++ b/src/testcases/org/apache/poi/ss/formula/FormulaParserTestHelper.java
@@ -23,7 +23,7 @@ import junit.framework.AssertionFailedError;
 import org.apache.poi.ss.formula.FormulaParser;

 import org.apache.poi.ss.formula.FormulaParser.FormulaParseException;

 /**

- * Avoids making {@link FormulaParser#FormulaParseException} public

+ * Avoids making {@link FormulaParseException} public

  * 

  * @author Josh Micich

  */