Package org.docx4j.openpackaging.parts.WordprocessingML

Class BinaryPart

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.parts.Part

org.docx4j.openpackaging.parts.WordprocessingML.BinaryPart

Direct Known Subclasses:

AbstractFontPart, AlternativeFormatInputPart, BinaryPartAbstractImage, EmbeddedPackagePart, FontDataPart, OleObjectBinaryPart, PrinterSettings, VMLBinaryPart

public class BinaryPart
extends Part

A part containing binary (as opposed to XML) data. The content of a binary parts is loaded lazily (ie only when required).

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	log

Fields inherited from class org.docx4j.openpackaging.parts.Part

pack

Fields inherited from class org.docx4j.openpackaging.Base

contentType, partName, relationships

Constructor Summary

Constructors

Constructor	Description
BinaryPart(ExternalTarget externalTarget)
BinaryPart(PartName partName)

Method Summary

Modifier and Type	Method	Description
ByteBuffer	getBuffer()	Get the contents of this part.
byte[]	getBytes()
ExternalTarget	getExternalTarget()
boolean	isContentEqual(Part other)
boolean	isLoaded()
void	setBinaryData(byte[] bytes)
void	setBinaryData(InputStream binaryData)
void	setBinaryData(ByteBuffer bb)
void	writeDataToOutputStream(OutputStream out)	Copy the ByteBuffer containing this part's binary data to an output stream.

Methods inherited from class org.docx4j.openpackaging.parts.Part

getContentLengthAsLoaded, getOwningRelationshipPart, getPackage, getRelationshipType, getSourceRelationship, getSourceRelationships, getVersion, remove, rename, setContentLengthAsLoaded, setOwningRelationshipPart, setPackage, setPartShortcut, setRelationshipType, setSourceRelationship, setVersion

Methods inherited from class org.docx4j.openpackaging.Base

addTargetPart, addTargetPart, addTargetPart, addTargetPart, getContentType, getPartName, getRelationshipsPart, getRelationshipsPart, getUserData, reset, setContentType, setPartName, setRelationships, setUserData

Methods inherited from class java.lang.Object

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

Field Details

log

protected static org.slf4j.Logger log

Constructor Details

BinaryPart

public BinaryPart(PartName partName)
           throws InvalidFormatException

Throws:

InvalidFormatException

BinaryPart

public BinaryPart(ExternalTarget externalTarget)

Method Details

getExternalTarget

public ExternalTarget getExternalTarget()

setBinaryData

public void setBinaryData(InputStream binaryData)

setBinaryData

public void setBinaryData(byte[] bytes)

setBinaryData

public void setBinaryData(ByteBuffer bb)

isLoaded

public boolean isLoaded()

Since:

3.0

getBuffer

public ByteBuffer getBuffer()

Get the contents of this part. NB: if you are moving this part from one pkg to another, you'll probably want to invoke this first, since otherwise the content may not be located (lazy loading).

Returns:

writeDataToOutputStream

public void writeDataToOutputStream(OutputStream out)
                             throws IOException

Copy the ByteBuffer containing this part's binary data to an output stream.

Parameters:

out -

Throws:

IOException

getBytes

public byte[] getBytes()

isContentEqual

public boolean isContentEqual(Part other)
                       throws Docx4JException

Specified by:

isContentEqual in class Part

Throws:

Docx4JException