You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2016/07/21 10:27:27 UTC
svn commit: r1753659 - in /poi/trunk/src:
java/org/apache/poi/POIDocument.java
scratchpad/src/org/apache/poi/POIReadOnlyDocument.java
Author: nick
Date: Thu Jul 21 10:27:27 2016
New Revision: 1753659
URL: http://svn.apache.org/viewvc?rev=1753659&view=rev
Log:
Javadoc updates
Modified:
poi/trunk/src/java/org/apache/poi/POIDocument.java
poi/trunk/src/scratchpad/src/org/apache/poi/POIReadOnlyDocument.java
Modified: poi/trunk/src/java/org/apache/poi/POIDocument.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/POIDocument.java?rev=1753659&r1=1753658&r2=1753659&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/POIDocument.java (original)
+++ poi/trunk/src/java/org/apache/poi/POIDocument.java Thu Jul 21 10:27:27 2016
@@ -347,6 +347,8 @@ public abstract class POIDocument implem
* instead of a File, or if this is not the root document. For those cases,
* you must use {@link #write(OutputStream)} or {@link #write(File)} to
* write to a brand new document.
+ *
+ * @since POI 3.15 beta 3
*
* @throws IOException thrown on errors writing to the file
*/
@@ -356,6 +358,8 @@ public abstract class POIDocument implem
* Writes the document out to the specified new {@link File}. If the file
* exists, it will be replaced, otherwise a new one will be created
*
+ * @since POI 3.15 beta 3
+ *
* @param newFile The new File to write to.
*
* @throws IOException thrown on errors writing to the file
Modified: poi/trunk/src/scratchpad/src/org/apache/poi/POIReadOnlyDocument.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/POIReadOnlyDocument.java?rev=1753659&r1=1753658&r2=1753659&view=diff
==============================================================================
--- poi/trunk/src/scratchpad/src/org/apache/poi/POIReadOnlyDocument.java (original)
+++ poi/trunk/src/scratchpad/src/org/apache/poi/POIReadOnlyDocument.java Thu Jul 21 10:27:27 2016
@@ -17,7 +17,6 @@
package org.apache.poi;
import java.io.File;
-import java.io.IOException;
import java.io.OutputStream;
import org.apache.poi.poifs.filesystem.DirectoryNode;
@@ -29,6 +28,8 @@ import org.apache.poi.poifs.filesystem.P
/**
* This holds the common functionality for all read-only
* POI Document classes, i.e. ones which don't support writing.
+ *
+ * @since POI 3.15 beta 3
*/
public abstract class POIReadOnlyDocument extends POIDocument {
public POIReadOnlyDocument(DirectoryNode dir) {
@@ -46,23 +47,29 @@ public abstract class POIReadOnlyDocumen
/**
* Note - writing is not yet supported for this file format, sorry.
+ *
+ * @throws IllegalStateException If you call the method, as writing is not supported
*/
@Override
- public void write() throws IOException {
+ public void write() {
throw new IllegalStateException("Writing is not yet implemented for this Document Format");
}
/**
* Note - writing is not yet supported for this file format, sorry.
+ *
+ * @throws IllegalStateException If you call the method, as writing is not supported
*/
@Override
- public void write(File file) throws IOException {
+ public void write(File file) {
throw new IllegalStateException("Writing is not yet implemented for this Document Format");
}
/**
* Note - writing is not yet supported for this file format, sorry.
+ *
+ * @throws IllegalStateException If you call the method, as writing is not supported
*/
@Override
- public void write(OutputStream out) throws IOException {
+ public void write(OutputStream out) {
throw new IllegalStateException("Writing is not yet implemented for this Document Format");
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org