From 48f255f37e272fa4f131d534753af21159432420 Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Thu, 21 Jul 2016 10:27:27 +0000 Subject: [PATCH] Javadoc updates git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1753659 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/poi/POIDocument.java | 4 ++++ .../src/org/apache/poi/POIReadOnlyDocument.java | 15 +++++++++++---- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/src/java/org/apache/poi/POIDocument.java b/src/java/org/apache/poi/POIDocument.java index 06f101d3d6..6b80bc6f43 100644 --- a/src/java/org/apache/poi/POIDocument.java +++ b/src/java/org/apache/poi/POIDocument.java @@ -347,6 +347,8 @@ public abstract class POIDocument implements Closeable { * 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 implements Closeable { * 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 diff --git a/src/scratchpad/src/org/apache/poi/POIReadOnlyDocument.java b/src/scratchpad/src/org/apache/poi/POIReadOnlyDocument.java index ae050e00a3..3b3eca588d 100644 --- a/src/scratchpad/src/org/apache/poi/POIReadOnlyDocument.java +++ b/src/scratchpad/src/org/apache/poi/POIReadOnlyDocument.java @@ -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.POIFSFileSystem; /** * 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 POIReadOnlyDocument extends POIDocument { /** * 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"); } } -- 2.39.5