diff --git a/poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java b/poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java index 84885b48d3..fdbcc89901 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java @@ -191,7 +191,7 @@ public class XLSX2CSV { * @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, + * @throws 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. diff --git a/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocument.java b/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocument.java index 216ff803e6..24479bad22 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocument.java +++ b/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocument.java @@ -81,7 +81,7 @@ public abstract class POIXMLDocument extends POIXMLDocumentPart implements Close * @param path the path to the document * @return the new OPCPackage * - * @exception IOException if there was a problem opening the document + * @throws IOException if there was a problem opening the document */ public static OPCPackage openPackage(String path) throws IOException { try { @@ -206,7 +206,7 @@ public abstract class POIXMLDocument extends POIXMLDocumentPart implements Close * * @param stream - the java OutputStream you wish to write the file to * - * @exception IOException if anything can't be written. + * @throws IOException if anything can't be written. */ @SuppressWarnings("resource") public final void write(OutputStream stream) throws IOException { diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java index c22fa1f68d..b9fb281997 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java @@ -57,7 +57,7 @@ public final class PackagePartCollection implements Serializable { * @param part part to put * @return the previous value associated with {@code partName}, or * {@code null} if there was no mapping for {@code partName}. - * @exception InvalidOperationException + * @throws InvalidOperationException * Throws if you try to add a part with a name derived from * another part name. */ diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/ContentTypeManager.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/ContentTypeManager.java index 1e53abcc61..1d47f0b45a 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/ContentTypeManager.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/ContentTypeManager.java @@ -208,7 +208,7 @@ public abstract class ContentTypeManager { * @param partName * The part URI associated with the override content type to * delete. - * @exception InvalidOperationException + * @throws InvalidOperationException * Throws if */ public void removeContentType(PackagePartName partName) @@ -323,7 +323,7 @@ public abstract class ContentTypeManager { * content type) or the extension (in case of default content type), * else null. * - * @exception OpenXML4JRuntimeException + * @throws OpenXML4JRuntimeException * Throws if the content type manager is not able to find the * content from an existing part. */ diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFCell.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFCell.java index 8659227b17..6d9fd1d4a8 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFCell.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFCell.java @@ -309,7 +309,7 @@ public class SXSSFCell extends CellBase { *

* @return the value of the cell as a number * @throws IllegalStateException if the cell type returned by {@link #getCellType()} is CellType.STRING - * @exception NumberFormatException if the cell value isn't a parsable double. + * @throws NumberFormatException if the cell value isn't a parsable double. * @see org.apache.poi.ss.usermodel.DataFormatter for turning this number into a string similar to that which Excel would render this number as. */ @Override @@ -341,7 +341,7 @@ public class SXSSFCell extends CellBase { *

* @return the value of the cell as a date * @throws IllegalStateException if the cell type returned by {@link #getCellType()} is CellType.STRING - * @exception NumberFormatException if the cell value isn't a parsable double. + * @throws NumberFormatException if the cell value isn't a parsable double. * @see org.apache.poi.ss.usermodel.DataFormatter for formatting this date into a string similar to how excel does. */ @Override @@ -365,7 +365,7 @@ public class SXSSFCell extends CellBase { *

* @return the value of the cell as a date * @throws IllegalStateException if the cell type returned by {@link #getCellType()} is CellType.STRING - * @exception NumberFormatException if the cell value isn't a parsable double. + * @throws NumberFormatException if the cell value isn't a parsable double. * @see org.apache.poi.ss.usermodel.DataFormatter for formatting this date into a string similar to how excel does. */ @Override diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java index 8273286ff8..fc499ad70e 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java @@ -949,7 +949,7 @@ public class SXSSFWorkbook implements Workbook { * Write out this workbook to an OutputStream. * * @param stream - the java OutputStream you wish to write to - * @exception IOException if anything can't be written. + * @throws IOException if anything can't be written. */ @Override public void write(OutputStream stream) throws IOException { @@ -982,7 +982,7 @@ public class SXSSFWorkbook implements Workbook { * so using this does not guarantee that there will be no temp file usage. * * @param stream - the java OutputStream you wish to write to - * @exception IOException if anything can't be written. + * @throws IOException if anything can't be written. * @since POI 5.1.0 (experimental and still liable to change or be removed) */ @Beta diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFCell.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFCell.java index de3a7a4a3d..8561f74ed1 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFCell.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFCell.java @@ -230,7 +230,7 @@ public final class XSSFCell extends CellBase { *

* @return the value of the cell as a number * @throws IllegalStateException if the cell type returned by {@link #getCellType()} is {@link CellType#STRING} - * @exception NumberFormatException if the cell value isn't a parsable {@code double}. + * @throws NumberFormatException if the cell value isn't a parsable {@code double}. * @see DataFormatter for turning this number into a string similar to that which Excel would render this number as. */ @Override @@ -671,7 +671,7 @@ public final class XSSFCell extends CellBase { *

* @return the value of the cell as a date * @throws IllegalStateException if the cell type returned by {@link #getCellType()} is {@link CellType#STRING} - * @exception NumberFormatException if the cell value isn't a parsable {@code double}. + * @throws NumberFormatException if the cell value isn't a parsable {@code double}. * @see DataFormatter for formatting this date into a string similar to how excel does. */ @Override @@ -692,7 +692,7 @@ public final class XSSFCell extends CellBase { *

* @return the value of the cell as a LocalDateTime * @throws IllegalStateException if the cell type returned by {@link #getCellType()} is {@link CellType#STRING} - * @exception NumberFormatException if the cell value isn't a parsable {@code double}. + * @throws NumberFormatException if the cell value isn't a parsable {@code double}. * @see DataFormatter for formatting this date into a string similar to how excel does. */ @Override diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hmef/HMEFMessage.java b/poi-scratchpad/src/main/java/org/apache/poi/hmef/HMEFMessage.java index 6997cbf87b..f6e3b6c801 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hmef/HMEFMessage.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hmef/HMEFMessage.java @@ -47,7 +47,13 @@ public final class HMEFMessage { private final List messageAttributes = new ArrayList<>(); private final List mapiAttributes = new ArrayList<>(); private final List attachments = new ArrayList<>(); - + + /** + * @param inp input stream + * @throws IOException + * @throws RuntimeException a number of runtime exceptions can be thrown, especially if there are problems with the + * input format + */ public HMEFMessage(InputStream inp) throws IOException { try { // Check the signature matches diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShow.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShow.java index f7c7d4fa7e..736aae9d58 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShow.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShow.java @@ -166,6 +166,9 @@ public final class HSLFSlideShow extends POIDocument implements SlideShowNote - this will buffer the whole message into memory * in order to process. For lower memory use, use {@link #MAPIMessage(File)} * - * @param in The InputStream to buffer then read from - * @exception IOException on errors reading, or invalid data + * @param in The InputStream to buffer and then read from + * @throws IOException on errors reading, or invalid data + * @throws RuntimeException a number of runtime exceptions can be thrown, especially if there are problems with the + * input format */ public MAPIMessage(InputStream in) throws IOException { this(new POIFSFileSystem(in)); @@ -134,7 +140,9 @@ public class MAPIMessage extends POIReadOnlyDocument { * Constructor for reading MSG Files from a POIFS filesystem * * @param fs Open POIFS FileSystem containing the message - * @exception IOException on errors reading, or invalid data + * @throws IOException on errors reading, or invalid data + * @throws RuntimeException a number of runtime exceptions can be thrown, especially if there are problems with the + * input format */ public MAPIMessage(POIFSFileSystem fs) throws IOException { this(fs.getRoot()); @@ -143,7 +151,9 @@ public class MAPIMessage extends POIReadOnlyDocument { * Constructor for reading MSG Files from a certain * point within a POIFS filesystem * @param poifsDir Directory containing the message - * @exception IOException on errors reading, or invalid data + * @throws IOException on errors reading, or invalid data + * @throws RuntimeException a number of runtime exceptions can be thrown, especially if there are problems with the + * input format */ public MAPIMessage(DirectoryNode poifsDir) throws IOException { super(poifsDir); diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hssf/converter/ExcelToHtmlConverter.java b/poi-scratchpad/src/main/java/org/apache/poi/hssf/converter/ExcelToHtmlConverter.java index 7c0fd29801..36e8b5983e 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hssf/converter/ExcelToHtmlConverter.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hssf/converter/ExcelToHtmlConverter.java @@ -104,6 +104,8 @@ public class ExcelToHtmlConverter extends AbstractExcelConverter { * @return DOM representation of result HTML * @throws IOException If an error occurs reading or writing files * @throws ParserConfigurationException If configuration is incorrect + * @throws RuntimeException a number of runtime exceptions can be thrown, especially if there are problems with the + * input format */ public static Document process(File xlsFile) throws IOException, ParserConfigurationException { try (HSSFWorkbook workbook = loadXls(xlsFile)) { @@ -118,6 +120,8 @@ public class ExcelToHtmlConverter extends AbstractExcelConverter { * @return DOM representation of result HTML * @throws IOException If an error occurs reading or writing files * @throws ParserConfigurationException If configuration is incorrect + * @throws RuntimeException a number of runtime exceptions can be thrown, especially if there are problems with the + * input format */ public static Document process(InputStream xlsStream) throws IOException, ParserConfigurationException { try (HSSFWorkbook workbook = new HSSFWorkbook(xlsStream)) { @@ -132,6 +136,8 @@ public class ExcelToHtmlConverter extends AbstractExcelConverter { * @return DOM representation of result HTML * @throws IOException If an error occurs reading or writing files * @throws ParserConfigurationException If configuration is incorrect + * @throws RuntimeException a number of runtime exceptions can be thrown, especially if there are problems with the + * input format */ public static Document process(HSSFWorkbook workbook) throws IOException, ParserConfigurationException { ExcelToHtmlConverter excelToHtmlConverter = new ExcelToHtmlConverter( diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hwmf/usermodel/HwmfPicture.java b/poi-scratchpad/src/main/java/org/apache/poi/hwmf/usermodel/HwmfPicture.java index 640212a382..ac57804945 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hwmf/usermodel/HwmfPicture.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hwmf/usermodel/HwmfPicture.java @@ -80,6 +80,12 @@ public class HwmfPicture implements Iterable, GenericRecord { return MAX_RECORD_LENGTH; } + /** + * @param inputStream + * @throws IOException + * @throws RuntimeException a number of runtime exceptions can be thrown, especially if there are problems with the + * input format + */ public HwmfPicture(InputStream inputStream) throws IOException { try (LittleEndianInputStream leis = new LittleEndianInputStream(inputStream)) { diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/HWPFDocument.java b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/HWPFDocument.java index f31df61f38..a058881977 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/HWPFDocument.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/HWPFDocument.java @@ -215,6 +215,8 @@ public final class HWPFDocument extends HWPFDocumentCore { * @throws IOException If there is an unexpected IOException from the passed * in InputStream. * @throws org.apache.poi.EmptyFileException If the given stream is empty + * @throws RuntimeException a number of other runtime exceptions can be thrown, especially if there are problems with the + * input format */ public HWPFDocument(InputStream istream) throws IOException { //do Ole stuff @@ -227,6 +229,8 @@ public final class HWPFDocument extends HWPFDocumentCore { * @param pfilesystem The POIFSFileSystem that contains the Word document. * @throws IOException If there is an unexpected IOException from the passed * in POIFSFileSystem. + * @throws RuntimeException a number of runtime exceptions can be thrown, especially if there are problems with the + * input format */ public HWPFDocument(POIFSFileSystem pfilesystem) throws IOException { this(pfilesystem.getRoot()); @@ -240,6 +244,8 @@ public final class HWPFDocument extends HWPFDocumentCore { * @param directory The DirectoryNode that contains the Word document. * @throws IOException If there is an unexpected IOException from the passed * in POIFSFileSystem. + * @throws RuntimeException a number of runtime exceptions can be thrown, especially if there are problems with the + * input format */ public HWPFDocument(DirectoryNode directory) throws IOException { // Load the main stream and FIB diff --git a/poi/src/main/java/org/apache/poi/hpsf/ClassID.java b/poi/src/main/java/org/apache/poi/hpsf/ClassID.java index 21aba376b0..7e0ec5e2d8 100644 --- a/poi/src/main/java/org/apache/poi/hpsf/ClassID.java +++ b/poi/src/main/java/org/apache/poi/hpsf/ClassID.java @@ -162,7 +162,7 @@ public class ClassID implements Duplicatable, GenericRecord { * * @param offset The offset within the {@code dst} byte array. * - * @exception ArrayStoreException if there is not enough room for the class + * @throws ArrayStoreException if there is not enough room for the class * ID 16 bytes in the byte array after the {@code offset} position. */ @SuppressWarnings("PointlessArithmeticExpression") diff --git a/poi/src/main/java/org/apache/poi/hpsf/DocumentSummaryInformation.java b/poi/src/main/java/org/apache/poi/hpsf/DocumentSummaryInformation.java index 9bd69be232..f96e12ac75 100644 --- a/poi/src/main/java/org/apache/poi/hpsf/DocumentSummaryInformation.java +++ b/poi/src/main/java/org/apache/poi/hpsf/DocumentSummaryInformation.java @@ -97,7 +97,7 @@ public class DocumentSummaryInformation extends PropertySet { * stream. * @throws IOException * if the {@link InputStream} cannot be accessed as needed. - * @exception NoPropertySetStreamException + * @throws NoPropertySetStreamException * if the input stream does not contain a property set. */ public DocumentSummaryInformation(final InputStream stream) diff --git a/poi/src/main/java/org/apache/poi/hpsf/Property.java b/poi/src/main/java/org/apache/poi/hpsf/Property.java index 2b05f763af..5587042f0c 100644 --- a/poi/src/main/java/org/apache/poi/hpsf/Property.java +++ b/poi/src/main/java/org/apache/poi/hpsf/Property.java @@ -125,7 +125,7 @@ public class Property { * @param length The property's type/value pair's length in bytes. * @param codepage The section's and thus the property's * codepage. It is needed only when reading string values. - * @exception UnsupportedEncodingException if the specified codepage is not + * @throws UnsupportedEncodingException if the specified codepage is not * supported. */ public Property(final long id, final byte[] src, final long offset, final int length, final int codepage) @@ -161,7 +161,7 @@ public class Property { * @param length The property's type/value pair's length in bytes. * @param codepage The section's and thus the property's * codepage. It is needed only when reading string values. - * @exception UnsupportedEncodingException if the specified codepage is not + * @throws UnsupportedEncodingException if the specified codepage is not * supported. */ public Property(final long id, LittleEndianByteArrayInputStream leis, final int length, final int codepage) @@ -255,7 +255,7 @@ public class Property { * * @return the property's size in bytes * - * @exception WritingNotSupportedException if HPSF does not yet support the + * @throws WritingNotSupportedException if HPSF does not yet support the * property's variant type. */ protected int getSize(int property) throws WritingNotSupportedException @@ -487,8 +487,8 @@ public class Property { * @param codepage The codepage to use for writing non-wide strings * @return the number of bytes written to the stream * - * @exception IOException if an I/O error occurs - * @exception WritingNotSupportedException if a variant type is to be + * @throws IOException if an I/O error occurs + * @throws WritingNotSupportedException if a variant type is to be * written that is not yet supported */ public int write(final OutputStream out, final int codepage) diff --git a/poi/src/main/java/org/apache/poi/hpsf/PropertySet.java b/poi/src/main/java/org/apache/poi/hpsf/PropertySet.java index eed2a7d4c8..acef3d7d36 100644 --- a/poi/src/main/java/org/apache/poi/hpsf/PropertySet.java +++ b/poi/src/main/java/org/apache/poi/hpsf/PropertySet.java @@ -179,9 +179,9 @@ public class PropertySet { * stream. * @throws IOException * if the {@link InputStream} cannot be accessed as needed. - * @exception NoPropertySetStreamException + * @throws NoPropertySetStreamException * if the input stream does not contain a property set. - * @exception UnsupportedEncodingException + * @throws UnsupportedEncodingException * if a character encoding is not supported. */ public PropertySet(final InputStream stream) @@ -208,7 +208,7 @@ public class PropertySet { * @throws NoPropertySetStreamException if the byte array is not a * property set stream. * - * @exception UnsupportedEncodingException if the codepage is not supported. + * @throws UnsupportedEncodingException if the codepage is not supported. */ public PropertySet(final byte[] stream, final int offset, final int length) throws NoPropertySetStreamException, UnsupportedEncodingException { @@ -227,7 +227,7 @@ public class PropertySet { * @throws NoPropertySetStreamException if the byte array is not a * property set stream. * - * @exception UnsupportedEncodingException if the codepage is not supported. + * @throws UnsupportedEncodingException if the codepage is not supported. */ public PropertySet(final byte[] stream) throws NoPropertySetStreamException, UnsupportedEncodingException { @@ -376,7 +376,7 @@ public class PropertySet { * {@link InputStream#mark} method. * @return {@code true} if the stream is a property set * stream, else {@code false}. - * @exception IOException if an I/O error occurs + * @throws IOException if an I/O error occurs */ public static boolean isPropertySetStream(final InputStream stream) throws IOException { /* @@ -500,9 +500,9 @@ public class PropertySet { * Writes the property set to an output stream. * * @param out the output stream to write the section to - * @exception IOException if an error when writing to the output stream + * @throws IOException if an error when writing to the output stream * occurs - * @exception WritingNotSupportedException if HPSF does not yet support + * @throws WritingNotSupportedException if HPSF does not yet support * writing a property's variant type. */ public void write(final OutputStream out) throws IOException, WritingNotSupportedException { diff --git a/poi/src/main/java/org/apache/poi/hpsf/PropertySetFactory.java b/poi/src/main/java/org/apache/poi/hpsf/PropertySetFactory.java index ec2b8bc9dd..350e3e605b 100644 --- a/poi/src/main/java/org/apache/poi/hpsf/PropertySetFactory.java +++ b/poi/src/main/java/org/apache/poi/hpsf/PropertySetFactory.java @@ -47,7 +47,7 @@ public class PropertySetFactory { * @throws NoPropertySetStreamException if the stream does not * contain a property set. * @throws IOException if some I/O problem occurs. - * @exception UnsupportedEncodingException if the specified codepage is not + * @throws UnsupportedEncodingException if the specified codepage is not * supported. */ public static PropertySet create(final DirectoryEntry dir, final String name) @@ -70,7 +70,7 @@ public class PropertySetFactory { * @throws NoPropertySetStreamException if the stream does not * contain a property set. * @throws IOException if some I/O problem occurs. - * @exception UnsupportedEncodingException if the specified codepage is not + * @throws UnsupportedEncodingException if the specified codepage is not * supported. */ public static PropertySet create(final InputStream stream) diff --git a/poi/src/main/java/org/apache/poi/hpsf/Section.java b/poi/src/main/java/org/apache/poi/hpsf/Section.java index 5636dbd400..e7c5245da9 100644 --- a/poi/src/main/java/org/apache/poi/hpsf/Section.java +++ b/poi/src/main/java/org/apache/poi/hpsf/Section.java @@ -116,7 +116,7 @@ public class Section { * @param offset The position in the stream that points to the * section's format ID. * - * @exception UnsupportedEncodingException if the section's codepage is not + * @throws UnsupportedEncodingException if the section's codepage is not * supported. */ public Section(final byte[] src, final int offset) throws UnsupportedEncodingException { @@ -711,8 +711,8 @@ public class Section { * @param out The stream to write into. * * @return The number of bytes written, i.e. the section's size. - * @exception IOException if an I/O error occurs - * @exception WritingNotSupportedException if HPSF does not yet support + * @throws IOException if an I/O error occurs + * @throws WritingNotSupportedException if HPSF does not yet support * writing a property's variant type. */ public int write(final OutputStream out) throws WritingNotSupportedException, IOException { @@ -855,7 +855,7 @@ public class Section { * * @param out The output stream to write to. * @param codepage The codepage to be used to write the dictionary items. - * @exception IOException if an I/O exception occurs. + * @throws IOException if an I/O exception occurs. */ private void writeDictionary(final OutputStream out, final int codepage) throws IOException { @@ -899,7 +899,7 @@ public class Section { * * @param dictionary The dictionary * - * @exception IllegalPropertySetDataException if the dictionary's key and + * @throws IllegalPropertySetDataException if the dictionary's key and * value types are not correct. * * @see Section#getDictionary() diff --git a/poi/src/main/java/org/apache/poi/hpsf/SummaryInformation.java b/poi/src/main/java/org/apache/poi/hpsf/SummaryInformation.java index 6b3bc861ff..15fb4b6750 100644 --- a/poi/src/main/java/org/apache/poi/hpsf/SummaryInformation.java +++ b/poi/src/main/java/org/apache/poi/hpsf/SummaryInformation.java @@ -87,9 +87,9 @@ public final class SummaryInformation extends PropertySet { * stream. * @throws IOException * if the {@link InputStream} cannot be accessed as needed. - * @exception NoPropertySetStreamException + * @throws NoPropertySetStreamException * if the input stream does not contain a property set. - * @exception UnsupportedEncodingException + * @throws UnsupportedEncodingException * if a character encoding is not supported. */ public SummaryInformation(final InputStream stream) diff --git a/poi/src/main/java/org/apache/poi/hpsf/VariantSupport.java b/poi/src/main/java/org/apache/poi/hpsf/VariantSupport.java index 1a0cce110c..71da6ad2da 100644 --- a/poi/src/main/java/org/apache/poi/hpsf/VariantSupport.java +++ b/poi/src/main/java/org/apache/poi/hpsf/VariantSupport.java @@ -152,9 +152,9 @@ public class VariantSupport extends Variant { * @return A Java object that corresponds best to the variant field. For * example, a VT_I4 is returned as a {@link Long}, a VT_LPSTR as a * {@link String}. - * @exception ReadingNotSupportedException if a property is to be written + * @throws ReadingNotSupportedException if a property is to be written * who's variant type HPSF does not yet support - * @exception UnsupportedEncodingException if the specified codepage is not + * @throws UnsupportedEncodingException if the specified codepage is not * supported. * @see Variant */ @@ -268,8 +268,8 @@ public class VariantSupport extends Variant { * @param codepage The codepage to use to write non-wide strings * @return The number of entities that have been written. In many cases an * "entity" is a byte but this is not always the case. - * @exception IOException if an I/O exceptions occurs - * @exception WritingNotSupportedException if a property is to be written + * @throws IOException if an I/O exceptions occurs + * @throws WritingNotSupportedException if a property is to be written * who's variant type HPSF does not yet support */ public static int write(final OutputStream out, final long type, diff --git a/poi/src/main/java/org/apache/poi/hssf/eventmodel/EventRecordFactory.java b/poi/src/main/java/org/apache/poi/hssf/eventmodel/EventRecordFactory.java index 234206a1ae..eb641fadb5 100644 --- a/poi/src/main/java/org/apache/poi/hssf/eventmodel/EventRecordFactory.java +++ b/poi/src/main/java/org/apache/poi/hssf/eventmodel/EventRecordFactory.java @@ -81,7 +81,7 @@ public final class EventRecordFactory { * @param in the InputStream from which the records will be * obtained * - * @exception RecordFormatException on error processing the + * @throws RecordFormatException on error processing the * InputStream */ public void processRecords(InputStream in) throws RecordFormatException { diff --git a/poi/src/main/java/org/apache/poi/hssf/record/RecordFactory.java b/poi/src/main/java/org/apache/poi/hssf/record/RecordFactory.java index 0828e46537..e69f8ee42c 100644 --- a/poi/src/main/java/org/apache/poi/hssf/record/RecordFactory.java +++ b/poi/src/main/java/org/apache/poi/hssf/record/RecordFactory.java @@ -160,7 +160,7 @@ public final class RecordFactory { * * @return an array of Records created from the InputStream * - * @exception org.apache.poi.util.RecordFormatException on error processing the InputStream + * @throws org.apache.poi.util.RecordFormatException on error processing the InputStream */ public static List createRecords(InputStream in) throws RecordFormatException { diff --git a/poi/src/main/java/org/apache/poi/hssf/record/RecordInputStream.java b/poi/src/main/java/org/apache/poi/hssf/record/RecordInputStream.java index b83100845b..e62431c672 100644 --- a/poi/src/main/java/org/apache/poi/hssf/record/RecordInputStream.java +++ b/poi/src/main/java/org/apache/poi/hssf/record/RecordInputStream.java @@ -361,7 +361,7 @@ public final class RecordInputStream implements LittleEndianInput { * * @param requestedLength the length of the final string * @return the converted string - * @exception IllegalArgumentException if len is too large (i.e., + * @throws IllegalArgumentException if len is too large (i.e., * there is not enough data in string to create a String of that * length) */ diff --git a/poi/src/main/java/org/apache/poi/poifs/eventfilesystem/POIFSReader.java b/poi/src/main/java/org/apache/poi/poifs/eventfilesystem/POIFSReader.java index 2c68c8d610..b8d443aab4 100644 --- a/poi/src/main/java/org/apache/poi/poifs/eventfilesystem/POIFSReader.java +++ b/poi/src/main/java/org/apache/poi/poifs/eventfilesystem/POIFSReader.java @@ -55,7 +55,7 @@ public class POIFSReader * * @param stream the InputStream from which to read the data * - * @exception IOException on errors reading, or on invalid data + * @throws IOException on errors reading, or on invalid data */ public void read(final InputStream stream) throws IOException { @@ -69,7 +69,7 @@ public class POIFSReader * * @param poifsFile the file from which to read the data * - * @exception IOException on errors reading, or on invalid data + * @throws IOException on errors reading, or on invalid data */ public void read(final File poifsFile) throws IOException { try (POIFSFileSystem poifs = new POIFSFileSystem(poifsFile, true)) { @@ -82,7 +82,7 @@ public class POIFSReader * * @param poifs the POIFSFileSystem from which to read the data * - * @exception IOException on errors reading, or on invalid data + * @throws IOException on errors reading, or on invalid data */ public void read(final POIFSFileSystem poifs) throws IOException { registryClosed = true; @@ -100,8 +100,8 @@ public class POIFSReader * * @param listener the listener to be registered * - * @exception NullPointerException if listener is null - * @exception IllegalStateException if read() has already been + * @throws NullPointerException if listener is null + * @throws IllegalStateException if read() has already been * called */ @@ -122,9 +122,9 @@ public class POIFSReader * @param listener the listener to be registered * @param name the document name * - * @exception NullPointerException if listener is null or name is + * @throws NullPointerException if listener is null or name is * null or empty - * @exception IllegalStateException if read() has already been + * @throws IllegalStateException if read() has already been * called */ @@ -141,9 +141,9 @@ public class POIFSReader * assumed * @param name the document name * - * @exception NullPointerException if listener is null or name is + * @throws NullPointerException if listener is null or name is * null or empty - * @exception IllegalStateException if read() has already been + * @throws IllegalStateException if read() has already been * called */ @@ -176,7 +176,7 @@ public class POIFSReader * * @param args names of the files * - * @exception IOException if the files can't be read or have invalid content + * @throws IOException if the files can't be read or have invalid content */ public static void main(String[] args) throws IOException { diff --git a/poi/src/main/java/org/apache/poi/poifs/filesystem/DirectoryEntry.java b/poi/src/main/java/org/apache/poi/poifs/filesystem/DirectoryEntry.java index bf70286dea..2c99782af9 100644 --- a/poi/src/main/java/org/apache/poi/poifs/filesystem/DirectoryEntry.java +++ b/poi/src/main/java/org/apache/poi/poifs/filesystem/DirectoryEntry.java @@ -90,7 +90,7 @@ public interface DirectoryEntry extends Entry, Iterable { * @return the specified Entry, if it is directly contained in * this DirectoryEntry * - * @exception FileNotFoundException if no Entry with the specified + * @throws FileNotFoundException if no Entry with the specified * name exists in this DirectoryEntry */ diff --git a/poi/src/main/java/org/apache/poi/poifs/filesystem/DirectoryNode.java b/poi/src/main/java/org/apache/poi/poifs/filesystem/DirectoryNode.java index a3a12eb6e9..3b233ab81d 100644 --- a/poi/src/main/java/org/apache/poi/poifs/filesystem/DirectoryNode.java +++ b/poi/src/main/java/org/apache/poi/poifs/filesystem/DirectoryNode.java @@ -126,7 +126,7 @@ public class DirectoryNode * * @return a newly opened DocumentInputStream * - * @exception IOException if the document does not exist or the + * @throws IOException if the document does not exist or the * name is that of a DirectoryEntry */ public DocumentInputStream createDocumentInputStream( @@ -143,7 +143,7 @@ public class DirectoryNode * * @return a newly opened DocumentInputStream or DocumentInputStream * - * @exception IOException if the document does not exist or the + * @throws IOException if the document does not exist or the * name is that of a DirectoryEntry */ public DocumentInputStream createDocumentInputStream( @@ -166,7 +166,7 @@ public class DirectoryNode * * @return the new DocumentEntry * - * @exception IOException if the document can't be created + * @throws IOException if the document can't be created */ DocumentEntry createDocument(final POIFSDocument document) throws IOException @@ -311,7 +311,7 @@ public class DirectoryNode * @return the specified Entry, if it is directly contained in * this DirectoryEntry * - * @exception FileNotFoundException if no Entry with the specified + * @throws FileNotFoundException if no Entry with the specified * name exists in this DirectoryEntry */ @@ -348,7 +348,7 @@ public class DirectoryNode * * @return the new DocumentEntry * - * @exception IOException if the document can't be created + * @throws IOException if the document can't be created */ @Override @@ -368,7 +368,7 @@ public class DirectoryNode * * @return the new DocumentEntry * - * @exception IOException if the document can't be created + * @throws IOException if the document can't be created */ @Override @@ -386,7 +386,7 @@ public class DirectoryNode * * @return the new DirectoryEntry * - * @exception IOException if the directory can't be created + * @throws IOException if the directory can't be created */ @Override @@ -413,7 +413,7 @@ public class DirectoryNode * * @return the new or updated DocumentEntry * - * @exception IOException if the document can't be created or its content be replaced + * @throws IOException if the document can't be created or its content be replaced */ @SuppressWarnings("WeakerAccess") public DocumentEntry createOrUpdateDocument(final String name, diff --git a/poi/src/main/java/org/apache/poi/poifs/filesystem/DocumentInputStream.java b/poi/src/main/java/org/apache/poi/poifs/filesystem/DocumentInputStream.java index 86b9fcd492..42add5e342 100644 --- a/poi/src/main/java/org/apache/poi/poifs/filesystem/DocumentInputStream.java +++ b/poi/src/main/java/org/apache/poi/poifs/filesystem/DocumentInputStream.java @@ -66,7 +66,7 @@ public final class DocumentInputStream extends InputStream implements LittleEndi * * @param document the DocumentEntry to be read * - * @exception IOException if the DocumentEntry cannot be opened (like, maybe it has + * @throws IOException if the DocumentEntry cannot be opened (like, maybe it has * been deleted?) */ public DocumentInputStream(DocumentEntry document) throws IOException { diff --git a/poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java b/poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java index 9fdd4e824f..2179ecdfdc 100644 --- a/poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java +++ b/poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java @@ -59,7 +59,7 @@ public class POIFSDocumentPath { * If the components parameter is null or has zero length, the POIFSDocumentPath is appropriate * for a document that is in the root of a POIFSFileSystem * - * @exception IllegalArgumentException + * @throws IllegalArgumentException * if any of the elements in the components parameter are null or have zero length */ public POIFSDocumentPath(final String [] components) throws IllegalArgumentException { @@ -72,7 +72,7 @@ public class POIFSDocumentPath { * @param path the existing path * @param components the additional subdirectory names to be added * - * @exception IllegalArgumentException + * @throws IllegalArgumentException * if any of the Strings in components is null or zero length */ public POIFSDocumentPath(final POIFSDocumentPath path, final String[] components) throws IllegalArgumentException { @@ -134,7 +134,7 @@ public class POIFSDocumentPath { * * @return the nth component; * - * @exception ArrayIndexOutOfBoundsException if n < 0 or n >= length() + * @throws ArrayIndexOutOfBoundsException if n < 0 or n >= length() */ public String getComponent(int n) throws ArrayIndexOutOfBoundsException { return components[ n ]; diff --git a/poi/src/main/java/org/apache/poi/poifs/property/DirectoryProperty.java b/poi/src/main/java/org/apache/poi/poifs/property/DirectoryProperty.java index badb306cba..0e72e089cd 100644 --- a/poi/src/main/java/org/apache/poi/poifs/property/DirectoryProperty.java +++ b/poi/src/main/java/org/apache/poi/poifs/property/DirectoryProperty.java @@ -249,7 +249,7 @@ public class DirectoryProperty extends Property implements Parent, Iterable { * * @param property the new child to be added; must not be null * - * @exception IOException if the Parent already has a child with + * @throws IOException if the Parent already has a child with * the same name */ diff --git a/poi/src/main/java/org/apache/poi/poifs/property/Property.java b/poi/src/main/java/org/apache/poi/poifs/property/Property.java index 63f677c8ce..92bcb9f603 100644 --- a/poi/src/main/java/org/apache/poi/poifs/property/Property.java +++ b/poi/src/main/java/org/apache/poi/poifs/property/Property.java @@ -167,7 +167,7 @@ public abstract class Property implements Child, POIFSViewable { * @param stream the OutputStream to which the data should be * written. * - * @exception IOException on problems writing to the specified + * @throws IOException on problems writing to the specified * stream. */ public void writeData(OutputStream stream) diff --git a/poi/src/main/java/org/apache/poi/poifs/property/PropertyTable.java b/poi/src/main/java/org/apache/poi/poifs/property/PropertyTable.java index d7a54c38c9..c595c71a99 100644 --- a/poi/src/main/java/org/apache/poi/poifs/property/PropertyTable.java +++ b/poi/src/main/java/org/apache/poi/poifs/property/PropertyTable.java @@ -64,7 +64,7 @@ public final class PropertyTable implements BATManaged { * @param headerBlock the header block of the file * @param filesystem the filesystem to read from * - * @exception IOException if anything goes wrong (which should be + * @throws IOException if anything goes wrong (which should be * a result of the input being NFG) */ public PropertyTable(final HeaderBlock headerBlock, final POIFSFileSystem filesystem) diff --git a/poi/src/main/java/org/apache/poi/poifs/storage/BATBlock.java b/poi/src/main/java/org/apache/poi/poifs/storage/BATBlock.java index 9ef00ad1f5..33bea9936a 100644 --- a/poi/src/main/java/org/apache/poi/poifs/storage/BATBlock.java +++ b/poi/src/main/java/org/apache/poi/poifs/storage/BATBlock.java @@ -257,7 +257,7 @@ public final class BATBlock implements BlockWritable { * @param stream the OutputStream to which the stored data should * be written * - * @exception IOException on problems writing to the specified + * @throws IOException on problems writing to the specified * stream */ public void writeBlocks(final OutputStream stream) throws IOException { diff --git a/poi/src/main/java/org/apache/poi/poifs/storage/BlockWritable.java b/poi/src/main/java/org/apache/poi/poifs/storage/BlockWritable.java index 96f6d181c9..e3e6b1d017 100644 --- a/poi/src/main/java/org/apache/poi/poifs/storage/BlockWritable.java +++ b/poi/src/main/java/org/apache/poi/poifs/storage/BlockWritable.java @@ -33,7 +33,7 @@ public interface BlockWritable { * @param stream the OutputStream to which the stored data should * be written * - * @exception IOException on problems writing to the specified + * @throws IOException on problems writing to the specified * stream */ diff --git a/poi/src/main/java/org/apache/poi/poifs/storage/HeaderBlock.java b/poi/src/main/java/org/apache/poi/poifs/storage/HeaderBlock.java index e3a450cfa2..96ba6c4e98 100644 --- a/poi/src/main/java/org/apache/poi/poifs/storage/HeaderBlock.java +++ b/poi/src/main/java/org/apache/poi/poifs/storage/HeaderBlock.java @@ -95,7 +95,7 @@ public final class HeaderBlock implements HeaderBlockConstants { * * @param stream the source InputStream * - * @exception IOException on errors or bad data + * @throws IOException on errors or bad data */ public HeaderBlock(InputStream stream) throws IOException { // Grab the first 512 bytes @@ -366,7 +366,7 @@ public final class HeaderBlock implements HeaderBlockConstants { * @param stream the OutputStream to which the stored data should * be written * - * @exception IOException on problems writing to the specified + * @throws IOException on problems writing to the specified * stream */ public void writeData(final OutputStream stream) throws IOException { diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/Cell.java b/poi/src/main/java/org/apache/poi/ss/usermodel/Cell.java index fb1e11d21a..a4130d51e6 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/Cell.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/Cell.java @@ -267,7 +267,7 @@ public interface Cell { *

* @return the value of the cell as a number * @throws IllegalStateException if the cell type returned by {@link #getCellType()} is {@link CellType#STRING} - * @exception NumberFormatException if the cell value isn't a parsable double. + * @throws NumberFormatException if the cell value isn't a parsable double. * @see DataFormatter for turning this number into a string similar to that which Excel would render this number as. */ double getNumericCellValue(); @@ -279,7 +279,7 @@ public interface Cell { *

* @return the value of the cell as a date * @throws IllegalStateException if the cell type returned by {@link #getCellType()} is {@link CellType#STRING} - * @exception NumberFormatException if the cell value isn't a parsable double. + * @throws NumberFormatException if the cell value isn't a parsable double. * @see DataFormatter for formatting this date into a string similar to how excel does. */ Date getDateCellValue(); @@ -291,7 +291,7 @@ public interface Cell { *

* @return the value of the cell as a LocalDateTime * @throws IllegalStateException if the cell type returned by {@link #getCellType()} is {@link CellType#STRING} - * @exception NumberFormatException if the cell value isn't a parsable double. + * @throws NumberFormatException if the cell value isn't a parsable double. * @see DataFormatter for formatting this date into a string similar to how excel does. */ LocalDateTime getLocalDateTimeCellValue(); diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/DateUtil.java b/poi/src/main/java/org/apache/poi/ss/usermodel/DateUtil.java index ba86243eb2..9527e825e4 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/DateUtil.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/DateUtil.java @@ -814,7 +814,7 @@ public class DateUtil { * * @return days number of days since 1900/12/31 * @param cal the Calendar - * @exception IllegalArgumentException if date is invalid + * @throws IllegalArgumentException if date is invalid */ protected static int absoluteDay(Calendar cal, boolean use1904windowing) { @@ -826,7 +826,7 @@ public class DateUtil { * * @return days number of days since 1900/12/31 * @param date the Date - * @exception IllegalArgumentException if date is invalid + * @throws IllegalArgumentException if date is invalid */ protected static int absoluteDay(LocalDateTime date, boolean use1904windowing) { @@ -839,7 +839,7 @@ public class DateUtil { * @return days number of days since 1900/12/31 * @param dayOfYear the day of the year * @param year the year - * @exception IllegalArgumentException if date is invalid + * @throws IllegalArgumentException if date is invalid */ private static int absoluteDay(int year, int dayOfYear, boolean use1904windowing) { return dayOfYear + daysInPriorYears(year, use1904windowing); @@ -851,7 +851,7 @@ public class DateUtil { * @return days number of days in years prior to yr. * @param yr a year (1900 < yr < 4000) * @param use1904windowing Should 1900 or 1904 date windowing be used? - * @exception IllegalArgumentException if year is outside of range. + * @throws IllegalArgumentException if year is outside of range. */ static int daysInPriorYears(int yr, boolean use1904windowing) diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/Workbook.java b/poi/src/main/java/org/apache/poi/ss/usermodel/Workbook.java index eac127a873..26a81725c0 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/Workbook.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/Workbook.java @@ -319,7 +319,7 @@ public interface Workbook extends Closeable, Iterable { * Write out this workbook to an OutputStream. * * @param stream - the java OutputStream you wish to write to - * @exception IOException if anything can't be written. + * @throws IOException if anything can't be written. */ void write(OutputStream stream) throws IOException; diff --git a/poi/src/main/java/org/apache/poi/util/ByteField.java b/poi/src/main/java/org/apache/poi/util/ByteField.java index 3d8df3eed8..2b2a466fe9 100644 --- a/poi/src/main/java/org/apache/poi/util/ByteField.java +++ b/poi/src/main/java/org/apache/poi/util/ByteField.java @@ -42,7 +42,7 @@ public class ByteField * * @param offset of the field within its byte array * - * @exception ArrayIndexOutOfBoundsException if offset is negative + * @throws ArrayIndexOutOfBoundsException if offset is negative */ public ByteField(final int offset) @@ -58,7 +58,7 @@ public class ByteField * @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 ByteField(final int offset, final byte value) @@ -80,7 +80,7 @@ public class ByteField * @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) */ @@ -100,7 +100,7 @@ public class ByteField * @param value the initial value * @param data the byte array to write the value to * - * @exception ArrayIndexOutOfBoundsException if the offset is not + * @throws ArrayIndexOutOfBoundsException if the offset is not * within the range of 0..(data.length - 1) */ @@ -139,7 +139,7 @@ public class ByteField * @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 the byte array's range */ @@ -157,7 +157,7 @@ public class ByteField * * @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 of the bte array */ @@ -173,9 +173,9 @@ public class ByteField * @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 */ @@ -197,7 +197,7 @@ public class ByteField * @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 the byte array's range */ diff --git a/poi/src/main/java/org/apache/poi/util/CodePageUtil.java b/poi/src/main/java/org/apache/poi/util/CodePageUtil.java index 2c1480253d..1b068c8754 100644 --- a/poi/src/main/java/org/apache/poi/util/CodePageUtil.java +++ b/poi/src/main/java/org/apache/poi/util/CodePageUtil.java @@ -250,7 +250,7 @@ public class CodePageUtil * eg "windows-1251", or "cp" followed by the number, e.g. if the codepage * number is 1252 the returned character encoding name will be "cp1252". * - * @exception UnsupportedEncodingException if the specified codepage is + * @throws UnsupportedEncodingException if the specified codepage is * less than zero. */ public static String codepageToEncoding(final int codepage) @@ -271,7 +271,7 @@ public class CodePageUtil * * @see Supported Encodings * - * @exception UnsupportedEncodingException if the specified codepage is + * @throws UnsupportedEncodingException if the specified codepage is * less than zero. */ public static String codepageToEncoding(final int codepage, boolean javaLangFormat) diff --git a/poi/src/main/java/org/apache/poi/util/FixedField.java b/poi/src/main/java/org/apache/poi/util/FixedField.java index f1334dfb09..407c15c941 100644 --- a/poi/src/main/java/org/apache/poi/util/FixedField.java +++ b/poi/src/main/java/org/apache/poi/util/FixedField.java @@ -35,7 +35,7 @@ public interface FixedField * * @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 the array's valid index range */ @@ -48,9 +48,9 @@ public interface FixedField * @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 */ @@ -64,7 +64,7 @@ public interface FixedField * @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 the array's valid index range */ diff --git a/poi/src/main/java/org/apache/poi/util/HexDump.java b/poi/src/main/java/org/apache/poi/util/HexDump.java index 184c48bd1e..f3ce580e4e 100644 --- a/poi/src/main/java/org/apache/poi/util/HexDump.java +++ b/poi/src/main/java/org/apache/poi/util/HexDump.java @@ -45,11 +45,11 @@ public final class HexDump { * @param index initial index into the byte array * @param length number of characters to output * - * @exception IOException is thrown if anything goes wrong writing + * @throws IOException is thrown if anything goes wrong writing * the data to stream - * @exception ArrayIndexOutOfBoundsException if the index is + * @throws ArrayIndexOutOfBoundsException if the index is * outside the data array's bounds - * @exception IllegalArgumentException if the output stream is + * @throws IllegalArgumentException if the output stream is * null */ public static void dump(final byte [] data, final long offset, @@ -73,11 +73,11 @@ public final class HexDump { * written * @param index initial index into the byte array * - * @exception IOException is thrown if anything goes wrong writing + * @throws IOException is thrown if anything goes wrong writing * the data to stream - * @exception ArrayIndexOutOfBoundsException if the index is + * @throws ArrayIndexOutOfBoundsException if the index is * outside the data array's bounds - * @exception IllegalArgumentException if the output stream is + * @throws IllegalArgumentException if the output stream is * null */ @@ -94,7 +94,7 @@ public final class HexDump { * @param offset its offset, whatever that might mean * @param index initial index into the byte array * - * @exception ArrayIndexOutOfBoundsException if the index is + * @throws ArrayIndexOutOfBoundsException if the index is * outside the data array's bounds * @return output string */ @@ -111,7 +111,7 @@ public final class HexDump { * @param index initial index into the byte array * @param length number of characters to output * - * @exception ArrayIndexOutOfBoundsException if the index is + * @throws ArrayIndexOutOfBoundsException if the index is * outside the data array's bounds * @return output string */ diff --git a/poi/src/main/java/org/apache/poi/util/IntList.java b/poi/src/main/java/org/apache/poi/util/IntList.java index acb2ddda2f..2c6cc86ae6 100644 --- a/poi/src/main/java/org/apache/poi/util/IntList.java +++ b/poi/src/main/java/org/apache/poi/util/IntList.java @@ -82,7 +82,7 @@ public class IntList * @param index the index where the new value is to be added * @param value the new value * - * @exception IndexOutOfBoundsException if the index is out of + * @throws IndexOutOfBoundsException if the index is out of * range (index < 0 || index > size()). */ @@ -176,7 +176,7 @@ public class IntList * * @return true if this list changed as a result of the call. * - * @exception IndexOutOfBoundsException if the index is out of + * @throws IndexOutOfBoundsException if the index is out of * range (index < 0 || index > size()) */ @@ -309,7 +309,7 @@ public class IntList * * @return the element at the specified position in this list. * - * @exception IndexOutOfBoundsException if the index is out of + * @throws IndexOutOfBoundsException if the index is out of * range (index < 0 || index >= size()). */ @@ -422,7 +422,7 @@ public class IntList * * @return the element previously at the specified position. * - * @exception IndexOutOfBoundsException if the index is out of + * @throws IndexOutOfBoundsException if the index is out of * range (index < 0 || index >= size()). */ @@ -531,7 +531,7 @@ public class IntList * * @return the element previously at the specified position. * - * @exception IndexOutOfBoundsException if the index is out of + * @throws IndexOutOfBoundsException if the index is out of * range (index < 0 || index >= size()). */ diff --git a/poi/src/main/java/org/apache/poi/util/IntegerField.java b/poi/src/main/java/org/apache/poi/util/IntegerField.java index 63554dae33..0d534862ed 100644 --- a/poi/src/main/java/org/apache/poi/util/IntegerField.java +++ b/poi/src/main/java/org/apache/poi/util/IntegerField.java @@ -40,7 +40,7 @@ public class IntegerField * * @param offset of the field within its byte array * - * @exception ArrayIndexOutOfBoundsException if the offset is + * @throws ArrayIndexOutOfBoundsException if the offset is * negative */ @@ -61,7 +61,7 @@ public class IntegerField * @param offset of the field within its byte array * @param value the initial value * - * @exception ArrayIndexOutOfBoundsException if the offset is + * @throws ArrayIndexOutOfBoundsException if the offset is * negative */ @@ -79,7 +79,7 @@ public class IntegerField * @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) */ @@ -99,7 +99,7 @@ public class IntegerField * @param value the initial value * @param data the byte array to write the value to * - * @exception ArrayIndexOutOfBoundsException if the offset is + * @throws ArrayIndexOutOfBoundsException if the offset is * negative or too large */ @@ -139,7 +139,7 @@ public class IntegerField * @param value to be set * @param data the byte array to write the value to * - * @exception ArrayIndexOutOfBoundsException if the offset is too + * @throws ArrayIndexOutOfBoundsException if the offset is too * large */ @@ -157,7 +157,7 @@ public class IntegerField * * @param data the byte array from which the value is to be read * - * @exception ArrayIndexOutOfBoundsException if the offset is too + * @throws ArrayIndexOutOfBoundsException if the offset is too * large */ @@ -173,9 +173,9 @@ public class IntegerField * @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 */ @@ -192,7 +192,7 @@ public class IntegerField * @param data the array of bytes to which the value is to be * written * - * @exception ArrayIndexOutOfBoundsException if the offset is too + * @throws ArrayIndexOutOfBoundsException if the offset is too * large */ diff --git a/poi/src/main/java/org/apache/poi/util/LittleEndian.java b/poi/src/main/java/org/apache/poi/util/LittleEndian.java index 09e9fd3ecb..cafd2479ee 100644 --- a/poi/src/main/java/org/apache/poi/util/LittleEndian.java +++ b/poi/src/main/java/org/apache/poi/util/LittleEndian.java @@ -491,7 +491,7 @@ public final class LittleEndian implements LittleEndianConsts { * @param value * the short (16-bit) value * - * @exception ArrayIndexOutOfBoundsException + * @throws ArrayIndexOutOfBoundsException * may be thrown */ public static void putUByte( byte[] data, int offset, short value ) { @@ -508,7 +508,7 @@ public final class LittleEndian implements LittleEndianConsts { * @param value * the int (32-bit) value * - * @exception ArrayIndexOutOfBoundsException + * @throws ArrayIndexOutOfBoundsException * may be thrown */ public static void putUInt( byte[] data, int offset, long value ) { @@ -546,7 +546,7 @@ public final class LittleEndian implements LittleEndianConsts { * @param value * the short (16-bit) value * - * @exception ArrayIndexOutOfBoundsException + * @throws ArrayIndexOutOfBoundsException * may be thrown */ public static void putUShort( byte[] data, int offset, int value ) { @@ -576,9 +576,9 @@ public final class LittleEndian implements LittleEndianConsts { * @param stream * the InputStream from which the int is to be read * @return the int (32-bit) value - * @exception IOException + * @throws IOException * will be propagated back to the caller - * @exception BufferUnderrunException + * @throws BufferUnderrunException * if the stream cannot provide enough bytes */ public static int readInt( InputStream stream ) throws IOException { @@ -599,9 +599,9 @@ public final class LittleEndian implements LittleEndianConsts { * @param stream * the InputStream from which the int is to be read * @return the unsigned int (32-bit) value - * @exception IOException + * @throws IOException * will be propagated back to the caller - * @exception BufferUnderrunException + * @throws BufferUnderrunException * if the stream cannot provide enough bytes */ public static long readUInt( InputStream stream ) throws IOException { @@ -615,9 +615,9 @@ public final class LittleEndian implements LittleEndianConsts { * @param stream * the InputStream from which the long is to be read * @return the long (64-bit) value - * @exception IOException + * @throws IOException * will be propagated back to the caller - * @exception BufferUnderrunException + * @throws BufferUnderrunException * if the stream cannot provide enough bytes */ public static long readLong( InputStream stream ) throws IOException { @@ -646,9 +646,9 @@ public final class LittleEndian implements LittleEndianConsts { * @param stream * the InputStream from which the short is to be read * @return the short (16-bit) value - * @exception IOException + * @throws IOException * will be propagated back to the caller - * @exception BufferUnderrunException + * @throws BufferUnderrunException * if the stream cannot provide enough bytes */ public static short readShort( InputStream stream ) throws IOException { diff --git a/poi/src/main/java/org/apache/poi/util/LittleEndianInputStream.java b/poi/src/main/java/org/apache/poi/util/LittleEndianInputStream.java index 0fb36f4254..93e66df0a7 100644 --- a/poi/src/main/java/org/apache/poi/util/LittleEndianInputStream.java +++ b/poi/src/main/java/org/apache/poi/util/LittleEndianInputStream.java @@ -97,7 +97,7 @@ public class LittleEndianInputStream extends FilterInputStream implements Little * get an unsigned int value from an InputStream * * @return the unsigned int (32-bit) value - * @exception RuntimeException + * @throws RuntimeException * wraps any IOException thrown from reading the stream. */ //@Override diff --git a/poi/src/main/java/org/apache/poi/util/LongField.java b/poi/src/main/java/org/apache/poi/util/LongField.java index 6d1ecc678d..6bba7cbf55 100644 --- a/poi/src/main/java/org/apache/poi/util/LongField.java +++ b/poi/src/main/java/org/apache/poi/util/LongField.java @@ -40,7 +40,7 @@ public class LongField * * @param offset of the field within its byte array * - * @exception ArrayIndexOutOfBoundsException if offset is negative + * @throws ArrayIndexOutOfBoundsException if offset is negative */ public LongField(final int offset) @@ -61,7 +61,7 @@ public class LongField * @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 LongField(final int offset, final long value) @@ -78,7 +78,7 @@ public class LongField * @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 LongField * @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 LongField(final int offset, final long value, final byte [] data) @@ -136,7 +136,7 @@ public class LongField * @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 LongField * * @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 LongField * @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 LongField * @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 */ diff --git a/poi/src/main/java/org/apache/poi/util/ShortField.java b/poi/src/main/java/org/apache/poi/util/ShortField.java index 424af8a858..e347c50190 100644 --- a/poi/src/main/java/org/apache/poi/util/ShortField.java +++ b/poi/src/main/java/org/apache/poi/util/ShortField.java @@ -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 */ diff --git a/poi/src/test/java/org/apache/poi/hpsf/basic/TestBasic.java b/poi/src/test/java/org/apache/poi/hpsf/basic/TestBasic.java index e2ce00ceb1..8ea0554d2d 100644 --- a/poi/src/test/java/org/apache/poi/hpsf/basic/TestBasic.java +++ b/poi/src/test/java/org/apache/poi/hpsf/basic/TestBasic.java @@ -73,8 +73,8 @@ final class TestBasic { /** *

Read a the test file from the "data" directory.

* - * @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}.

* - * @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}.

* - * @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}.

* - * @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 { diff --git a/poi/src/test/java/org/apache/poi/hpsf/basic/TestEmptyProperties.java b/poi/src/test/java/org/apache/poi/hpsf/basic/TestEmptyProperties.java index 2cb8086c0c..9ec3ccad4a 100644 --- a/poi/src/test/java/org/apache/poi/hpsf/basic/TestEmptyProperties.java +++ b/poi/src/test/java/org/apache/poi/hpsf/basic/TestEmptyProperties.java @@ -65,9 +65,9 @@ final class TestEmptyProperties { /** *

Read a the test file from the "data" directory.

* - * @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}.

* - * @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}.

* - * @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 { diff --git a/poi/src/test/java/org/apache/poi/hpsf/basic/TestUnicode.java b/poi/src/test/java/org/apache/poi/hpsf/basic/TestUnicode.java index 360af38c8b..471d2a1797 100644 --- a/poi/src/test/java/org/apache/poi/hpsf/basic/TestUnicode.java +++ b/poi/src/test/java/org/apache/poi/hpsf/basic/TestUnicode.java @@ -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 { diff --git a/poi/src/test/java/org/apache/poi/hpsf/basic/TestWrite.java b/poi/src/test/java/org/apache/poi/hpsf/basic/TestWrite.java index 32b35eb991..5af30cd978 100644 --- a/poi/src/test/java/org/apache/poi/hpsf/basic/TestWrite.java +++ b/poi/src/test/java/org/apache/poi/hpsf/basic/TestWrite.java @@ -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 { *

Writes a simple property set with a SummaryInformation section 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 @@ -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 diff --git a/poi/src/test/java/org/apache/poi/hpsf/basic/Util.java b/poi/src/test/java/org/apache/poi/hpsf/basic/Util.java index a7159ce3e5..881b43ec4b 100644 --- a/poi/src/test/java/org/apache/poi/hpsf/basic/Util.java +++ b/poi/src/test/java/org/apache/poi/hpsf/basic/Util.java @@ -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 readPOIFiles(final File poiFs, final String... poiFiles) throws IOException { final List 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 readPropertySets(final File poiFs) throws IOException { final List files = new ArrayList<>(7); diff --git a/poi/src/test/java/org/apache/poi/hssf/dev/BiffViewer.java b/poi/src/test/java/org/apache/poi/hssf/dev/BiffViewer.java index 274c140f17..b9e97f7bfa 100644 --- a/poi/src/test/java/org/apache/poi/hssf/dev/BiffViewer.java +++ b/poi/src/test/java/org/apache/poi/hssf/dev/BiffViewer.java @@ -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); diff --git a/src/resources/devtools/poi.jin b/src/resources/devtools/poi.jin index c52acef808..eb0d8bf443 100644 --- a/src/resources/devtools/poi.jin +++ b/src/resources/devtools/poi.jin @@ -152,7 +152,7 @@ javaDocMethodParam[00] = " * @param $paramName$" 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] = "/**"