Package org.apache.poi.openxml4j.opc.internal

Class TempFilePackagePart

java.lang.Object

org.apache.poi.openxml4j.opc.PackagePart

org.apache.poi.openxml4j.opc.internal.TempFilePackagePart

All Implemented Interfaces:

Comparable<PackagePart>, RelationshipSource

@Beta
public final class TempFilePackagePart
extends PackagePart

(Experimental) Temp File version of a package part.

Since:

POI 5.1.0

Field Summary

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

_container, _contentType, _partName

Constructor Summary

Constructors

Constructor	Description
TempFilePackagePart(OPCPackage pack, PackagePartName partName, String contentType)	Constructor.
TempFilePackagePart(OPCPackage pack, PackagePartName partName, String contentType, boolean loadRelationships)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	clear()	Allows sub-classes to clean up before new data is added.
void	close()	Close this part : flush this part, close the input stream and output stream.
void	flush()	Flush the content of this part.
protected InputStream	getInputStreamImpl()	Method that gets the input stream for this part.
protected OutputStream	getOutputStreamImpl()	Method that gets the output stream for this part.
long	getSize()
boolean	load(InputStream is)	Load the content of this part.
boolean	save(OutputStream os)	Save the content of this part and the associated relationships part (if this part own at least one relationship) into the specified output stream.

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

addExternalRelationship, addExternalRelationship, addRelationship, addRelationship, addRelationship, addRelationship, clearRelationships, compareTo, findExistingRelation, getContentType, getContentTypeDetails, getInputStream, getOutputStream, getPackage, getPartName, getRelatedPart, getRelationship, getRelationships, getRelationshipsByType, hasRelationships, isDeleted, isRelationshipExists, isRelationshipPart, removeRelationship, setContentType, setDeleted, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TempFilePackagePart

public TempFilePackagePart(OPCPackage pack,
                           PackagePartName partName,
                           String contentType)
                    throws InvalidFormatException,
                           IOException

Constructor.

Parameters:

pack - The owner package.

partName - The part name.

contentType - The content type.

Throws:

InvalidFormatException - If the specified URI is not OPC compliant.

IOException - If temp file cannot be created.

TempFilePackagePart

public TempFilePackagePart(OPCPackage pack,
                           PackagePartName partName,
                           String contentType,
                           boolean loadRelationships)
                    throws InvalidFormatException,
                           IOException

Constructor.

Parameters:

pack - The owner package.

partName - The part name.

contentType - The content type.

loadRelationships - Specify if the relationships will be loaded.

Throws:

InvalidFormatException - If the specified URI is not OPC compliant.

IOException - If temp file cannot be created.

Method Detail

getInputStreamImpl

protected InputStream getInputStreamImpl()
                                  throws IOException

Description copied from class: PackagePart

Method that gets the input stream for this part.

Specified by:

getInputStreamImpl in class PackagePart

Returns:

input stream for this part

Throws:

IOException - Throws if an IO Exception occur in the implementation method.

getOutputStreamImpl

protected OutputStream getOutputStreamImpl()
                                    throws IOException

Description copied from class: PackagePart

Method that gets the output stream for this part.

Specified by:

getOutputStreamImpl in class PackagePart

Returns:

output stream for this part

Throws:

IOException - Throws if an IO Exception occur in the implementation method.

getSize

public long getSize()

Overrides:

getSize in class PackagePart

Returns:

The length of the part in bytes, or -1 if not known

clear

public void clear()

Description copied from class: PackagePart

Allows sub-classes to clean up before new data is added.

Overrides:

clear in class PackagePart

save

public boolean save(OutputStream os)
             throws OpenXML4JException

Description copied from class: PackagePart

Save the content of this part and the associated relationships part (if this part own at least one relationship) into the specified output stream.

Specified by:

save in class PackagePart

Parameters:

os - Output stream to save this part.

Returns:

true if the content has been successfully stored, false otherwise. More information about errors may be logged via Log4j 2.

Throws:

OpenXML4JException - If any exception occur.

load

public boolean load(InputStream is)
             throws InvalidFormatException

Description copied from class: PackagePart

Load the content of this part.

Specified by:

load in class PackagePart

Parameters:

is - The input stream of the content to load.

Returns:

true if the content has been successfully loaded, false otherwise. More information about errors may be logged via Log4j 2.

Throws:

InvalidFormatException - Throws if the content format is invalid.

close

public void close()

Description copied from class: PackagePart

Close this part : flush this part, close the input stream and output stream. After this method call, the part must be available for packaging.

Specified by:

close in class PackagePart

flush

public void flush()

Description copied from class: PackagePart

Flush the content of this part. If the input stream and/or output stream as in a waiting state to read or write, the must to empty their respective buffer.

Specified by:

flush in class PackagePart