|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.poifs.filesystem.Ole10Native
public class Ole10Native
Represents an Ole10Native record which is wrapped around certain binary files being embedded in OLE2 documents.
Field Summary | |
---|---|
static java.lang.String |
OLE10_NATIVE
|
Constructor Summary | |
---|---|
Ole10Native(byte[] data,
int offset)
Creates an instance and fills the fields based on the data in the given buffer. |
|
Ole10Native(byte[] data,
int offset,
boolean plain)
Creates an instance and fills the fields based on the data in the given buffer. |
Method Summary | |
---|---|
static Ole10Native |
createFromEmbeddedOleObject(DirectoryNode directory)
Creates an instance of this class from an embedded OLE Object. |
static Ole10Native |
createFromEmbeddedOleObject(POIFSFileSystem poifs)
Creates an instance of this class from an embedded OLE Object. |
java.lang.String |
getCommand()
Returns the command field - usually the name of the file being embedded including the full path, may be a command specified during embedding the file. |
byte[] |
getDataBuffer()
Returns the buffer containing the embedded file's data, or null
if no data was embedded. |
int |
getDataSize()
Returns the size of the embedded file. |
java.lang.String |
getFileName()
Returns the fileName field - usually the name of the file being embedded including the full path. |
short |
getFlags1()
Returns flags1 - currently unknown - usually 0x0002. |
short |
getFlags2()
Returns flags2 - currently unknown - mostly 0x0000. |
short |
getFlags3()
Returns the flags3 - currently unknown. |
java.lang.String |
getLabel()
Returns the label field - usually the name of the file (without directory) but probably may be any name specified during packaging/embedding the data. |
int |
getTotalSize()
Returns the value of the totalSize field - the total length of the structure is totalSize + 4 (value of this field + size of this field). |
byte[] |
getUnknown1()
Returns unknown1 field - currently unknown. |
byte[] |
getUnknown2()
Returns the unknown2 field - currently being a byte[3] - mostly {0, 0, 0}. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String OLE10_NATIVE
Constructor Detail |
---|
public Ole10Native(byte[] data, int offset) throws Ole10NativeException
data
- The buffer containing the Ole10Native recordoffset
- The start offset of the record in the buffer
Ole10NativeException
- on invalid or unexcepted data formatpublic Ole10Native(byte[] data, int offset, boolean plain) throws Ole10NativeException
data
- The buffer containing the Ole10Native recordoffset
- The start offset of the record in the bufferplain
- Specified 'plain' format without filename
Ole10NativeException
- on invalid or unexcepted data formatMethod Detail |
---|
public static Ole10Native createFromEmbeddedOleObject(POIFSFileSystem poifs) throws java.io.IOException, Ole10NativeException
poifs
- POI Filesystem object
java.io.IOException
- on IO error
Ole10NativeException
- on invalid or unexcepted data formatpublic static Ole10Native createFromEmbeddedOleObject(DirectoryNode directory) throws java.io.IOException, Ole10NativeException
directory
- POI Filesystem object
java.io.IOException
- on IO error
Ole10NativeException
- on invalid or unexcepted data formatpublic int getTotalSize()
public short getFlags1()
public java.lang.String getLabel()
public java.lang.String getFileName()
public short getFlags2()
public byte[] getUnknown1()
public byte[] getUnknown2()
public java.lang.String getCommand()
public int getDataSize()
getDataBuffer()
returns null
.
public byte[] getDataBuffer()
null
if no data was embedded. Note that an embedding may provide information about
the data, but the actual data is not included. (So label, filename etc. are
available, but this method returns null
.)
public short getFlags3()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |