From: Dominik Stadler <centic@apache.org>
Date: Sun, 11 Dec 2016 21:13:46 +0000 (+0000)
Subject: Adjust some missing/incorrec throws and related javadoc
X-Git-Tag: REL_3_16_BETA2~191
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=9f68c40e345aabf655c37eb402ad63d5e173e03f;p=poi.git

Adjust some missing/incorrec throws and related javadoc

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

diff --git a/src/examples/src/org/apache/poi/xssf/eventusermodel/XLSX2CSV.java b/src/examples/src/org/apache/poi/xssf/eventusermodel/XLSX2CSV.java
index 0f84ce91fe..bd537c1d15 100644
--- a/src/examples/src/org/apache/poi/xssf/eventusermodel/XLSX2CSV.java
+++ b/src/examples/src/org/apache/poi/xssf/eventusermodel/XLSX2CSV.java
@@ -126,6 +126,7 @@ public class XLSX2CSV {
             
             // Number or string?
             try {
+                //noinspection ResultOfMethodCallIgnored
                 Double.parseDouble(formattedValue);
                 output.append(formattedValue);
             } catch (NumberFormatException e) {
@@ -173,16 +174,20 @@ public class XLSX2CSV {
      * Parses and shows the content of one sheet
      * using the specified styles and shared-strings tables.
      *
-     * @param styles
-     * @param strings
-     * @param sheetInputStream
+     * @param styles The table of styles that may be referenced by cells in the sheet
+     * @param strings The table of strings that may be referenced by cells in the sheet
+     * @param sheetInputStream The stream to read the sheet-data from.
+
+     * @exception java.io.IOException An IO exception from the parser,
+     *            possibly from a byte stream or character stream
+     *            supplied by the application.
+     * @throws SAXException if parsing the XML data fails.
      */
     public void processSheet(
             StylesTable styles,
             ReadOnlySharedStringsTable strings,
             SheetContentsHandler sheetHandler, 
-            InputStream sheetInputStream)
-            throws IOException, ParserConfigurationException, SAXException {
+            InputStream sheetInputStream) throws IOException, SAXException {
         DataFormatter formatter = new DataFormatter();
         InputSource sheetSource = new InputSource(sheetInputStream);
         try {
@@ -199,13 +204,10 @@ public class XLSX2CSV {
     /**
      * Initiates the processing of the XLS workbook file to CSV.
      *
-     * @throws IOException
-     * @throws OpenXML4JException
-     * @throws ParserConfigurationException
-     * @throws SAXException
+     * @throws IOException If reading the data from the package fails.
+     * @throws SAXException if parsing the XML data fails.
      */
-    public void process()
-            throws IOException, OpenXML4JException, ParserConfigurationException, SAXException {
+    public void process() throws IOException, OpenXML4JException, SAXException {
         ReadOnlySharedStringsTable strings = new ReadOnlySharedStringsTable(this.xlsxPackage);
         XSSFReader xssfReader = new XSSFReader(this.xlsxPackage);
         StylesTable styles = xssfReader.getStylesTable();
diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePart.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePart.java
index 23969fa68a..641e1bc196 100644
--- a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePart.java
+++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePart.java
@@ -228,9 +228,7 @@ public abstract class PackagePart implements RelationshipSource, Comparable<Pack
 	 * @throws InvalidOperationException
 	 *             If a writing operation is done on a read only package or 
 	 *             invalid nested relations are created.
-	 * @throws InvalidFormatException
-	 *             If the URI point to a relationship part URI.
-	 * @throws IllegalArgumentException if targetPartName, targetMode 
+	 * @throws IllegalArgumentException if targetPartName, targetMode
 	 *             or relationshipType are passed as null
 	 * @see org.apache.poi.openxml4j.opc.RelationshipSource#addRelationship(org.apache.poi.openxml4j.opc.PackagePartName,
 	 *      org.apache.poi.openxml4j.opc.TargetMode, java.lang.String, java.lang.String)
@@ -300,7 +298,7 @@ public abstract class PackagePart implements RelationshipSource, Comparable<Pack
 	 *            Relationship unique id.
 	 * @return The newly created and added relationship
 	 *
-	 * @throws InvalidFormatException
+	 * @throws InvalidOperationException
 	 *             If the URI point to a relationship part URI.
 	 * @see org.apache.poi.openxml4j.opc.RelationshipSource#addRelationship(org.apache.poi.openxml4j.opc.PackagePartName,
 	 *      org.apache.poi.openxml4j.opc.TargetMode, java.lang.String, java.lang.String)
@@ -361,7 +359,8 @@ public abstract class PackagePart implements RelationshipSource, Comparable<Pack
 	 * Retrieve all the relationships attached to this part.
 	 *
 	 * @return This part's relationships.
-	 * @throws OpenXML4JException
+	 * @throws InvalidOperationException
+	 *             Throws if the package is open en write only mode.
 	 * @see org.apache.poi.openxml4j.opc.RelationshipSource#getRelationships()
 	 */
 	public PackageRelationshipCollection getRelationships()
@@ -491,6 +490,8 @@ public abstract class PackagePart implements RelationshipSource, Comparable<Pack
 	 *
 	 * @return The input stream of the content of this part, else
 	 *         <code>null</code>.
+	 *
+	 * @throws IOException If creating the input-stream fails.
 	 */
 	public InputStream getInputStream() throws IOException {
 		InputStream inStream = this.getInputStreamImpl();
@@ -503,7 +504,7 @@ public abstract class PackagePart implements RelationshipSource, Comparable<Pack
 
 	/**
 	 * Get the output stream of this part. If the part is originally embedded in
-	 * Zip package, it'll be transform intot a <i>MemoryPackagePart</i> in
+	 * Zip package, it'll be transform into a <i>MemoryPackagePart</i> in
 	 * order to write inside (the standard Java API doesn't allow to write in
 	 * the file)
 	 *
@@ -643,7 +644,7 @@ public abstract class PackagePart implements RelationshipSource, Comparable<Pack
 	@Override
 	public String toString() {
 		return "Name: " + this._partName + " - Content Type: "
-				+ this._contentType.toString();
+				+ this._contentType;
 	}
 
 	/**
@@ -662,7 +663,7 @@ public abstract class PackagePart implements RelationshipSource, Comparable<Pack
 	/*-------------- Abstract methods ------------- */
 
 	/**
-	 * Abtract method that get the input stream of this part.
+	 * Abstract method that get the input stream of this part.
 	 *
 	 * @exception IOException
 	 *                Throws if an IO Exception occur in the implementation
diff --git a/src/ooxml/java/org/apache/poi/xssf/eventusermodel/ReadOnlySharedStringsTable.java b/src/ooxml/java/org/apache/poi/xssf/eventusermodel/ReadOnlySharedStringsTable.java
index 92252dd52b..4de27401db 100644
--- a/src/ooxml/java/org/apache/poi/xssf/eventusermodel/ReadOnlySharedStringsTable.java
+++ b/src/ooxml/java/org/apache/poi/xssf/eventusermodel/ReadOnlySharedStringsTable.java
@@ -96,10 +96,9 @@ public class ReadOnlySharedStringsTable extends DefaultHandler {
     private List<String> strings;
 
     /**
-     * @param pkg
-     * @throws IOException
-     * @throws SAXException
-     * @throws ParserConfigurationException
+     * @param pkg The {@link OPCPackage} to use as basis for the shared-strings table.
+     * @throws IOException If reading the data from the package fails.
+     * @throws SAXException if parsing the XML data fails.
      */
     public ReadOnlySharedStringsTable(OPCPackage pkg)
             throws IOException, SAXException {
@@ -126,9 +125,8 @@ public class ReadOnlySharedStringsTable extends DefaultHandler {
      * Read this shared strings table from an XML file.
      *
      * @param is The input stream containing the XML document.
-     * @throws IOException                  if an error occurs while reading.
-     * @throws SAXException
-     * @throws ParserConfigurationException
+     * @throws IOException if an error occurs while reading.
+     * @throws SAXException if parsing the XML data fails.
      */
     public void readFrom(InputStream is) throws IOException, SAXException {
         // test if the file is empty, otherwise parse it