org.apache.poi.openxml4j.opc

Class ZipPackage

java.lang.Object

org.apache.poi.openxml4j.opc.OPCPackage

org.apache.poi.openxml4j.opc.ZipPackage

All Implemented Interfaces:

Closeable, AutoCloseable, RelationshipSource

public final class ZipPackage
extends OPCPackage

Physical zip package.

Field Summary

Fields inherited from class org.apache.poi.openxml4j.opc.OPCPackage

contentTypeManager, defaultPackageAccess, defaultPartMarshaller, isDirty, originalPackagePath, output, packageProperties, partMarshallers, partUnmarshallers, relationships

Constructor Summary

Constructors

Constructor and Description
ZipPackage() Constructor.
ZipPackage(OPCComplianceFlags opcComplianceFlags) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	closeImpl() Close and save the package.
protected PackagePart	createPartImpl(PackagePartName partName, String contentType, boolean loadRelationships) Create a new MemoryPackagePart from the specified URI and content type
static boolean	encryptTempFilePackageParts()
protected void	flushImpl() Flush the package.
protected PackagePartCollection	getPartsImpl() Retrieves the parts from this package.
ZipEntrySource	getZipArchive() Get the zip archive
boolean	isClosed() Has close been called already?
protected void	revertImpl() Close the package without saving the document.
void	saveImpl(OutputStream outputStream) Save this package into the specified stream
static void	setEncryptTempFilePackageParts(boolean encryptTempFiles)
static void	setUseTempFilePackageParts(boolean tempFilePackageParts)
static boolean	useTempFilePackageParts()

Methods inherited from class org.apache.poi.openxml4j.opc.OPCPackage

addExternalRelationship, addExternalRelationship, addMarshaller, addPackagePart, addRelationship, addRelationship, addThumbnail, addThumbnail, addUnmarshaller, clearRelationships, close, closeParts, containPart, create, create, create, createPart, createPart, deletePart, deletePartRecursive, ensureRelationships, flush, getPackageAccess, getPackageProperties, getPart, getPart, getParts, getPartsByContentType, getPartsByName, getPartsByRelationshipType, getRelationship, getRelationships, getRelationshipsByType, getUnusedPartIndex, hasPackagePart, hasRelationships, isRelationshipExists, isStrictOoxmlFormat, open, open, open, open, open, open, open, open, open, open, open, open, open, open, openOrCreate, registerPartAndContentType, removeMarshaller, removePart, removePart, removePartImpl, removePartRecursive, removeRelationship, removeUnmarshaller, replaceContentType, revert, save, save, toString, unregisterPartAndContentType, validatePackage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ZipPackage

public ZipPackage()

Constructor. Creates a new, empty ZipPackage.

ZipPackage

public ZipPackage(OPCComplianceFlags opcComplianceFlags)

Constructor. Creates a new, empty ZipPackage.

Parameters:

opcComplianceFlags - The level of OPC compliance to enforce when reading the package

Since:

POI 5.4.1

Method Detail

setUseTempFilePackageParts

public static void setUseTempFilePackageParts(boolean tempFilePackageParts)

Parameters:

tempFilePackageParts - whether to save package part data in temp files to save memory

setEncryptTempFilePackageParts

public static void setEncryptTempFilePackageParts(boolean encryptTempFiles)

Parameters:

encryptTempFiles - whether to encrypt package part temp files

useTempFilePackageParts

public static boolean useTempFilePackageParts()

Returns:

whether package part data is stored in temp files to save memory

encryptTempFilePackageParts

public static boolean encryptTempFilePackageParts()

Returns:

whether package part temp files are encrypted

getPartsImpl

protected PackagePartCollection getPartsImpl()
                                      throws InvalidFormatException

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 archive and look for all parts contain inside it.

Specified by:

getPartsImpl in class OPCPackage

Returns:

All parts contain in this package.

Throws:

InvalidFormatException - if the package is not valid.

createPartImpl

protected PackagePart createPartImpl(PackagePartName partName,
                                     String contentType,
                                     boolean loadRelationships)

Create a new MemoryPackagePart from the specified URI and content type

Specified by:

createPartImpl in class OPCPackage

Parameters:

partName - The part name.

contentType - The part content type.

loadRelationships - whether to load relationships.

Returns:

The newly created zip package part, else null.

Throws:

IllegalArgumentException - if partName or contentType is null

flushImpl

protected void flushImpl()

Flush the package. Do nothing.

Specified by:

flushImpl in class OPCPackage

closeImpl

protected void closeImpl()
                  throws IOException

Close and save the package.

Specified by:

closeImpl in class OPCPackage

Throws:

IOException

See Also:

OPCPackage.close()

revertImpl

protected void revertImpl()

Close the package without saving the document. Discard all the changes made to this package.

Specified by:

revertImpl in class OPCPackage

saveImpl

public void saveImpl(OutputStream outputStream)

Save this package into the specified stream

Specified by:

saveImpl in class OPCPackage

Parameters:

outputStream - The stream use to save this package.

Throws:

OpenXML4JRuntimeException - if there is an error while saving the package.

See Also:

OPCPackage.save(OutputStream)

getZipArchive

public ZipEntrySource getZipArchive()

Get the zip archive

Returns:

The zip archive.

isClosed

public boolean isClosed()

Description copied from class: OPCPackage

Has close been called already?

Specified by:

isClosed in class OPCPackage