You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by fa...@apache.org on 2021/12/18 17:41:36 UTC
svn commit: r1896139 [2/2] - in /poi/trunk: poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/ poi-ooxml/src/main/java/org/apache/poi/ooxml/ poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/ poi-ooxml/src/main/java/org/apache/p...
Modified: poi/trunk/poi/src/main/java/org/apache/poi/util/ShortField.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/main/java/org/apache/poi/util/ShortField.java?rev=1896139&r1=1896138&r2=1896139&view=diff
==============================================================================
--- poi/trunk/poi/src/main/java/org/apache/poi/util/ShortField.java (original)
+++ poi/trunk/poi/src/main/java/org/apache/poi/util/ShortField.java Sat Dec 18 17:41:36 2021
@@ -40,7 +40,7 @@ public class ShortField
*
* @param offset of the field within its byte array
*
- * @exception ArrayIndexOutOfBoundsException if offset is negative
+ * @throws ArrayIndexOutOfBoundsException if offset is negative
*/
public ShortField(final int offset)
@@ -61,7 +61,7 @@ public class ShortField
* @param offset of the field within its byte array
* @param value the initial value
*
- * @exception ArrayIndexOutOfBoundsException if offset is negative
+ * @throws ArrayIndexOutOfBoundsException if offset is negative
*/
public ShortField(final int offset, final short value)
@@ -78,7 +78,7 @@ public class ShortField
* @param offset of the field within its byte array
* @param data the byte array to read the value from
*
- * @exception ArrayIndexOutOfBoundsException if the offset is not
+ * @throws ArrayIndexOutOfBoundsException if the offset is not
* within the range of 0..(data.length - 1)
*/
@@ -98,7 +98,7 @@ public class ShortField
* @param value the initial value
* @param data the byte array to write the value to
*
- * @exception ArrayIndexOutOfBoundsException if offset is negative
+ * @throws ArrayIndexOutOfBoundsException if offset is negative
*/
public ShortField(final int offset, final short value, final byte [] data)
@@ -136,7 +136,7 @@ public class ShortField
* @param value to be set
* @param data the byte array to write the value to
*
- * @exception ArrayIndexOutOfBoundsException if the offset is out
+ * @throws ArrayIndexOutOfBoundsException if the offset is out
* of range
*/
@@ -154,7 +154,7 @@ public class ShortField
*
* @param data the byte array from which the value is to be read
*
- * @exception ArrayIndexOutOfBoundsException if the offset is out
+ * @throws ArrayIndexOutOfBoundsException if the offset is out
* of range
*/
@@ -170,9 +170,9 @@ public class ShortField
* @param stream the InputStream from which the value is to be
* read
*
- * @exception BufferUnderrunException if there is not enough data
+ * @throws BufferUnderrunException if there is not enough data
* available from the InputStream
- * @exception IOException if an IOException is thrown from reading
+ * @throws IOException if an IOException is thrown from reading
* the InputStream
*/
@@ -189,7 +189,7 @@ public class ShortField
* @param data the array of bytes to which the value is to be
* written
*
- * @exception ArrayIndexOutOfBoundsException if the offset is out
+ * @throws ArrayIndexOutOfBoundsException if the offset is out
* of range
*/
Modified: poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestBasic.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestBasic.java?rev=1896139&r1=1896138&r2=1896139&view=diff
==============================================================================
--- poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestBasic.java (original)
+++ poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestBasic.java Sat Dec 18 17:41:36 2021
@@ -73,8 +73,8 @@ final class TestBasic {
/**
* <p>Read a the test file from the "data" directory.</p>
*
- * @exception FileNotFoundException if the file to be read does not exist.
- * @exception IOException if any other I/O exception occurs.
+ * @throws FileNotFoundException if the file to be read does not exist.
+ * @throws IOException if any other I/O exception occurs.
*/
@BeforeEach
void setUp() throws IOException {
@@ -103,9 +103,9 @@ final class TestBasic {
* NoPropertySetStreamException} will be thrown when trying to
* create a {@link PropertySet}.</p>
*
- * @exception IOException if an I/O exception occurs.
+ * @throws IOException if an I/O exception occurs.
*
- * @exception UnsupportedEncodingException if a character encoding is not
+ * @throws UnsupportedEncodingException if a character encoding is not
* supported.
*/
@Test
@@ -135,8 +135,8 @@ final class TestBasic {
* property sets: the first one is a {@link SummaryInformation},
* the second one is a {@link DocumentSummaryInformation}.</p>
*
- * @exception IOException if an I/O exception occurs
- * @exception HPSFException if any HPSF exception occurs
+ * @throws IOException if an I/O exception occurs
+ * @throws HPSFException if any HPSF exception occurs
*/
@Test
void testPropertySetMethods() throws IOException, HPSFException {
@@ -159,8 +159,8 @@ final class TestBasic {
* property sets: the first one is a {@link SummaryInformation},
* the second one is a {@link DocumentSummaryInformation}.</p>
*
- * @exception IOException if an I/O exception occurs
- * @exception HPSFException if any HPSF exception occurs
+ * @throws IOException if an I/O exception occurs
+ * @throws HPSFException if any HPSF exception occurs
*/
@Test
void testSectionMethods() throws IOException, HPSFException {
Modified: poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestEmptyProperties.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestEmptyProperties.java?rev=1896139&r1=1896138&r2=1896139&view=diff
==============================================================================
--- poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestEmptyProperties.java (original)
+++ poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestEmptyProperties.java Sat Dec 18 17:41:36 2021
@@ -65,9 +65,9 @@ final class TestEmptyProperties {
/**
* <p>Read a the test file from the "data" directory.</p>
*
- * @exception FileNotFoundException if the file containing the test data
+ * @throws FileNotFoundException if the file containing the test data
* does not exist
- * @exception IOException if an I/O exception occurs
+ * @throws IOException if an I/O exception occurs
*/
@BeforeEach
void setUp() throws IOException {
@@ -95,9 +95,9 @@ final class TestEmptyProperties {
* NoPropertySetStreamException} will be thrown when trying to
* create a {@link PropertySet}.</p>
*
- * @exception IOException if an I/O exception occurs.
+ * @throws IOException if an I/O exception occurs.
*
- * @exception UnsupportedEncodingException if a character encoding is not
+ * @throws UnsupportedEncodingException if a character encoding is not
* supported.
*/
@Test
@@ -125,8 +125,8 @@ final class TestEmptyProperties {
* property sets: the first one is a {@link SummaryInformation},
* the second one is a {@link DocumentSummaryInformation}.</p>
*
- * @exception IOException if an I/O exception occurs
- * @exception HPSFException if an HPSF operation fails
+ * @throws IOException if an I/O exception occurs
+ * @throws HPSFException if an HPSF operation fails
*/
@Test
void testPropertySetMethods() throws IOException, HPSFException {
Modified: poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestUnicode.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestUnicode.java?rev=1896139&r1=1896138&r2=1896139&view=diff
==============================================================================
--- poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestUnicode.java (original)
+++ poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestUnicode.java Sat Dec 18 17:41:36 2021
@@ -45,8 +45,8 @@ class TestUnicode {
* property set: the first one is a {@link SummaryInformation},
* the second one is a {@link DocumentSummaryInformation}.
*
- * @exception IOException if an I/O exception occurs
- * @exception HPSFException if an HPSF exception occurs
+ * @throws IOException if an I/O exception occurs
+ * @throws HPSFException if an HPSF exception occurs
*/
@Test
void testPropertySetMethods() throws IOException, HPSFException {
Modified: poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestWrite.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestWrite.java?rev=1896139&r1=1896138&r2=1896139&view=diff
==============================================================================
--- poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestWrite.java (original)
+++ poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/TestWrite.java Sat Dec 18 17:41:36 2021
@@ -95,7 +95,7 @@ class TestWrite {
/**
* Writes an empty property set to a POIFS and reads it back in.
*
- * @exception IOException if an I/O exception occurs
+ * @throws IOException if an I/O exception occurs
*/
@Test
void withoutAFormatID() throws Exception {
@@ -120,8 +120,8 @@ class TestWrite {
/**
* Writes an empty property set to a POIFS and reads it back in.
*
- * @exception IOException if an I/O exception occurs
- * @exception UnsupportedVariantTypeException if HPSF does not yet support
+ * @throws IOException if an I/O exception occurs
+ * @throws UnsupportedVariantTypeException if HPSF does not yet support
* a variant type to be written
*/
@Test
@@ -154,8 +154,8 @@ class TestWrite {
* <p>Writes a simple property set with a SummaryInformation section to a
* POIFS and reads it back in.</p>
*
- * @exception IOException if an I/O exception occurs
- * @exception UnsupportedVariantTypeException if HPSF does not yet support
+ * @throws IOException if an I/O exception occurs
+ * @throws UnsupportedVariantTypeException if HPSF does not yet support
* a variant type to be written
*/
@Test
@@ -206,8 +206,8 @@ class TestWrite {
* Writes a simple property set with two sections to a POIFS and reads it
* back in.
*
- * @exception IOException if an I/O exception occurs
- * @exception WritingNotSupportedException if HPSF does not yet support
+ * @throws IOException if an I/O exception occurs
+ * @throws WritingNotSupportedException if HPSF does not yet support
* a variant type to be written
*/
@Test
Modified: poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/Util.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/Util.java?rev=1896139&r1=1896138&r2=1896139&view=diff
==============================================================================
--- poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/Util.java (original)
+++ poi/trunk/poi/src/test/java/org/apache/poi/hpsf/basic/Util.java Sat Dec 18 17:41:36 2021
@@ -56,10 +56,10 @@ final class Util {
* @return The POI files. The elements are ordered in the same way
* as the files in the POI filesystem.
*
- * @exception FileNotFoundException if the file containing the POI
+ * @throws FileNotFoundException if the file containing the POI
* filesystem does not exist
*
- * @exception IOException if an I/O exception occurs
+ * @throws IOException if an I/O exception occurs
*/
static List<POIFile> readPOIFiles(final File poiFs, final String... poiFiles) throws IOException {
final List<POIFile> files = new ArrayList<>();
@@ -100,7 +100,7 @@ final class Util {
* @return The property sets. The elements are ordered in the same way
* as the files in the POI filesystem.
*
- * @exception IOException if an I/O exception occurs
+ * @throws IOException if an I/O exception occurs
*/
static List<POIFile> readPropertySets(final File poiFs) throws IOException {
final List<POIFile> files = new ArrayList<>(7);
Modified: poi/trunk/poi/src/test/java/org/apache/poi/hssf/dev/BiffViewer.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/test/java/org/apache/poi/hssf/dev/BiffViewer.java?rev=1896139&r1=1896138&r2=1896139&view=diff
==============================================================================
--- poi/trunk/poi/src/test/java/org/apache/poi/hssf/dev/BiffViewer.java (original)
+++ poi/trunk/poi/src/test/java/org/apache/poi/hssf/dev/BiffViewer.java Sat Dec 18 17:41:36 2021
@@ -154,7 +154,7 @@ public final class BiffViewer {
* @param is the InputStream from which the records will be obtained
* @param ps the PrintWriter to output the record data
*
- * @exception RecordFormatException on error processing the InputStream
+ * @throws RecordFormatException on error processing the InputStream
*/
private void createRecords(InputStream is, PrintWriter ps) throws RecordFormatException {
RecordInputStream recStream = new RecordInputStream(is);
Modified: poi/trunk/src/resources/devtools/poi.jin
URL: http://svn.apache.org/viewvc/poi/trunk/src/resources/devtools/poi.jin?rev=1896139&r1=1896138&r2=1896139&view=diff
==============================================================================
--- poi/trunk/src/resources/devtools/poi.jin (original)
+++ poi/trunk/src/resources/devtools/poi.jin Sat Dec 18 17:41:36 2021
@@ -152,7 +152,7 @@ javaDocMethodParam[00]
javaDocMethodReturn[00] = " *"
javaDocMethodReturn[01] = " * @return"
javaDocMethodExceptionSeparator[00] = " *"
-javaDocMethodException[00] = " * @exception $exceptionName$"
+javaDocMethodException[00] = " * @throws $exceptionName$"
javaDocMethodBottom[00] = " *"
javaDocMethodBottom[01] = " */"
javaDocConstructorTop[00] = "/**"
@@ -161,7 +161,7 @@ javaDocConstructorTop[02]
javaDocConstructorParamSeparator[00] = " *"
javaDocConstructorParam[00] = " * @param $paramName$"
javaDocConstructorExceptionSeparator[00] = " *"
-javaDocConstructorException[00] = " * @exception $exceptionName$"
+javaDocConstructorException[00] = " * @throws $exceptionName$"
javaDocConstructorBottom[00] = " *"
javaDocConstructorBottom[01] = " */"
javaDocClass[00] = "/**"
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org