Apache POI - Common 5.3.0 · org.apache.poi.sl.usermodel.ObjectData

Method Summary

Modifier and Type	Method and Description
public default byte[]	Returns: the embedded data. getBytes() Convenience method to get the embedded data as byte array.
public default DirectoryEntry	Returns: the object data as an OLE2 directory. getDirectory() Gets the object data.
public String	Returns: a filename suggestion - inspecting/interpreting the Directory object probably gives a better result getFileName()
public InputStream	Returns: the input stream which will contain the binary of the embedded data. getInputStream() Gets an input stream which returns the binary of the embedded data.
public String	Returns: the OLE2 Class Name of the object getOLE2ClassName()
public OutputStream	Returns: the object data as stream (for writing) getOutputStream()
public default boolean	Returns: does this ObjectData have an associated POIFS Directory Entry? (Not all do, those that don't have a data portion) hasDirectoryEntry()

getBytes	back to summary
public default byte[] getBytes() throws IOException Convenience method to get the embedded data as byte array. Returns:byte[] the embedded data.

getBytes

public default byte[] getBytes() throws IOException

Convenience method to get the embedded data as byte array.

getDirectory back to summary

getDirectory	back to summary
public default DirectoryEntry getDirectory() throws IOException Gets the object data. Only call for ones that have data though. See `hasDirectoryEntry()`. The caller has to close the corresponding POIFSFileSystem Returns:DirectoryEntry the object data as an OLE2 directory. Annotations @SuppressWarnings:resource Exceptions IOException: if there was an error reading the data.

public default DirectoryEntry getDirectory() throws IOException

Gets the object data. Only call for ones that have data though. See hasDirectoryEntry(). The caller has to close the corresponding POIFSFileSystem

the object data as an OLE2 directory.

Annotations

Exceptions

getFileName	back to summary
public String getFileName() Returns:String a filename suggestion - inspecting/interpreting the Directory object probably gives a better result

getInputStream	back to summary
public InputStream getInputStream() throws IOException Gets an input stream which returns the binary of the embedded data. Returns:InputStream the input stream which will contain the binary of the embedded data.

getInputStream

public InputStream getInputStream() throws IOException

Gets an input stream which returns the binary of the embedded data.

Returns:InputStream: the input stream which will contain the binary of the embedded data.

getOLE2ClassName	back to summary
public String getOLE2ClassName() Returns:String the OLE2 Class Name of the object

getOutputStream	back to summary
public OutputStream getOutputStream() throws IOException Returns:OutputStream the object data as stream (for writing)

hasDirectoryEntry	back to summary
public default boolean hasDirectoryEntry() Returns:boolean does this ObjectData have an associated POIFS Directory Entry? (Not all do, those that don't have a data portion)