Package 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
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 -
Method Summary
Modifier and TypeMethodDescriptionprotected voidClose and save the package.protected PackagePartcreatePartImpl(PackagePartName partName, String contentType, boolean loadRelationships) Create a new MemoryPackagePart from the specified URI and content type aram partName The part URI.protected voidFlush the package.protected PackagePartCollectionRetrieves the parts from this package.Get the zip archiveprotected voidremovePartImpl(PackagePartName partName) Delete a part from the packageprotected voidClose the package without saving the document.voidsaveImpl(OutputStream outputStream) Save this package into the specified streamMethods inherited from class org.apache.poi.openxml4j.opc.OPCPackage
addExternalRelationship, addExternalRelationship, addMarshaller, addPackagePart, addRelationship, addRelationship, addThumbnail, addThumbnail, addUnmarshaller, clearRelationships, close, containPart, create, create, create, createPart, createPart, deletePart, deletePartRecursive, ensureRelationships, flush, getPackageAccess, getPackageProperties, getPart, getPart, getParts, getPartsByContentType, getPartsByName, getPartsByRelationshipType, getRelationship, getRelationships, getRelationshipsByType, getUnusedPartIndex, hasRelationships, isRelationshipExists, open, open, open, open, open, open, openOrCreate, registerPartAndContentType, removeMarshaller, removePart, removePart, removePartRecursive, removeRelationship, removeUnmarshaller, replaceContentType, revert, save, save, unregisterPartAndContentType, validatePackage
-
Constructor Details
-
ZipPackage
public ZipPackage()Constructor. Creates a new, empty ZipPackage.
-
-
Method Details
-
getPartsImpl
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:
getPartsImplin classOPCPackage- 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 aram partName The part URI.- Specified by:
createPartImplin classOPCPackage- Parameters:
contentType- The part content type.partName- URI of the part to create.- Returns:
- The newly created zip package part, else null.
-
removePartImpl
Delete a part from the package- Specified by:
removePartImplin classOPCPackage- Parameters:
partName- The URI of the part to delete.- Throws:
IllegalArgumentException- Throws if the part URI is nulll or invalid.
-
flushImpl
protected void flushImpl()Flush the package. Do nothing.- Specified by:
flushImplin classOPCPackage
-
closeImpl
Close and save the package.- Specified by:
closeImplin classOPCPackage- Throws:
IOException- See Also:
-
revertImpl
protected void revertImpl()Close the package without saving the document. Discard all the changes made to this package.- Specified by:
revertImplin classOPCPackage
-
saveImpl
Save this package into the specified stream- Specified by:
saveImplin classOPCPackage- Parameters:
outputStream- The stream use to save this package.- See Also:
-
getZipArchive
Get the zip archive- Returns:
- The zip archive.
-