moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Javadoc updates

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1753659 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2016-07-21 10:27:27 +00:00
parent 327a4aa091
commit 50519d3c73
2 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/java/org/apache/poi/POIDocument.java
View File

@ -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, * 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 * you must use {@link #write(OutputStream)} or {@link #write(File)} to
* write to a brand new document. * write to a brand new document.
*
* @since POI 3.15 beta 3
* *
* @throws IOException thrown on errors writing to the file * @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 * 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 * 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. * @param newFile The new File to write to.
* *
* @throws IOException thrown on errors writing to the file * @throws IOException thrown on errors writing to the file

15
src/scratchpad/src/org/apache/poi/POIReadOnlyDocument.java
View File

@ -17,7 +17,6 @@
package org.apache.poi; package org.apache.poi;
import java.io.File; import java.io.File;
import java.io.IOException;
import java.io.OutputStream; import java.io.OutputStream;
import org.apache.poi.poifs.filesystem.DirectoryNode; 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 * This holds the common functionality for all read-only
* POI Document classes, i.e. ones which don't support writing. * POI Document classes, i.e. ones which don't support writing.
*
* @since POI 3.15 beta 3
*/ */
public abstract class POIReadOnlyDocument extends POIDocument { public abstract class POIReadOnlyDocument extends POIDocument {
public POIReadOnlyDocument(DirectoryNode dir) { 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. * Note - writing is not yet supported for this file format, sorry.
*
* @throws IllegalStateException If you call the method, as writing is not supported
*/ */
@Override @Override
public void write() throws IOException { public void write() {
throw new IllegalStateException("Writing is not yet implemented for this Document Format"); throw new IllegalStateException("Writing is not yet implemented for this Document Format");
} }
/** /**
* Note - writing is not yet supported for this file format, sorry. * Note - writing is not yet supported for this file format, sorry.
*
* @throws IllegalStateException If you call the method, as writing is not supported
*/ */
@Override @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"); throw new IllegalStateException("Writing is not yet implemented for this Document Format");
} }
/** /**
* Note - writing is not yet supported for this file format, sorry. * Note - writing is not yet supported for this file format, sorry.
*
* @throws IllegalStateException If you call the method, as writing is not supported
*/ */
@Override @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"); throw new IllegalStateException("Writing is not yet implemented for this Document Format");
} }
} }