Fix some JavaDocs, and add a generic constructor based on ZipEntrySource

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1540986 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2013-11-12 09:51:13 +00:00
parent 6780a911e2
commit 381cc611d7

View File

@ -42,8 +42,8 @@ import org.apache.poi.openxml4j.opc.internal.marshallers.ZipPartMarshaller;
import org.apache.poi.openxml4j.util.ZipEntrySource; import org.apache.poi.openxml4j.util.ZipEntrySource;
import org.apache.poi.openxml4j.util.ZipFileZipEntrySource; import org.apache.poi.openxml4j.util.ZipFileZipEntrySource;
import org.apache.poi.openxml4j.util.ZipInputStreamZipEntrySource; import org.apache.poi.openxml4j.util.ZipInputStreamZipEntrySource;
import org.apache.poi.util.POILogger;
import org.apache.poi.util.POILogFactory; import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger;
/** /**
* Physical zip package. * Physical zip package.
@ -69,11 +69,13 @@ public final class ZipPackage extends Package {
} }
/** /**
* Constructor. <b>Operation not supported.</b> * Constructor. Opens a Zip based Open XML document from
* an InputStream.
* *
* @param in * @param in
* Zip input stream to load. * Zip input stream to load.
* @param access * @param access
* The package access mode.
* @throws IllegalArgumentException * @throws IllegalArgumentException
* If the specified input stream not an instance of * If the specified input stream not an instance of
* ZipInputStream. * ZipInputStream.
@ -86,7 +88,7 @@ public final class ZipPackage extends Package {
} }
/** /**
* Constructor. Opens a Zip based Open XML document. * Constructor. Opens a Zip based Open XML document from a File.
* *
* @param path * @param path
* The path of the file to open or create. * The path of the file to open or create.
@ -135,6 +137,23 @@ public final class ZipPackage extends Package {
this.zipArchive = new ZipFileZipEntrySource(zipFile); this.zipArchive = new ZipFileZipEntrySource(zipFile);
} }
/**
* Constructor. Opens a Zip based Open XML document from
* a custom ZipEntrySource, typically an open archive
* from another system
*
* @param zipEntry
* Zip data to load.
* @param access
* The package access mode.
* @throws InvalidFormatException
* If the content type part parsing encounters an error.
*/
ZipPackage(ZipEntrySource zipEntry, PackageAccess access) {
super(access);
this.zipArchive = zipEntry;
}
/** /**
* Retrieves the parts from this package. We assume that the package has not * Retrieves the parts from this package. We assume that the package has not
* been yet inspect to retrieve all the parts, this method will open the * been yet inspect to retrieve all the parts, this method will open the