Ole10Native (POI API Documentation)

java.lang.Object
- org.apache.poi.poifs.filesystem.Ole10Native

```
public class Ole10Native
extends java.lang.Object
```
Represents an Ole10Native record which is wrapped around certain binary files being embedded in OLE2 documents.
Ole10Native objects come in different shapes:
- unparsed: we can't identify it's structure
- compact: same as unparsed but with a leading flag
- parsed - Ole-Class "Package": data + ASCII label,command,filename
- parsed - Ole-Class "Package2": as above plus UTF16 label,command,filename

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String OLE10_NATIVE

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`OLE10_NATIVE`

Constructor Summary

Constructors
Constructor and Description
`Ole10Native(byte[] data, int offset)` Creates an instance and fills the fields based on the data in the given buffer.
`Ole10Native(java.lang.String label, java.lang.String filename, java.lang.String command, byte[] data)` Creates an instance and fills the fields based on ...

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`static void`	`createOleMarkerEntry(DirectoryEntry parent)` Add the \1OLE marker entry, which is not the Ole10Native entry.
`static void`	`createOleMarkerEntry(POIFSFileSystem poifs)` Add the \1OLE marker entry, which is not the Ole10Native entry.
`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.
`java.lang.String`	`getCommand2()` Get Command string of UTF16 extended OLE packages or `null` if not set or not UTF16 extended
`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.
`java.lang.String`	`getFileName2()` Get filename string for UTF16 extended OLE packages or `null` if not set or not UTF16 extended
`short`	`getFlags1()` Returns flags1 - currently unknown - usually 0x0002.
`short`	`getFlags2()` Returns flags2 - currently unknown - mostly 0x0000.
`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.
`java.lang.String`	`getLabel2()` Get Label string for UTF16 extended OLE packages or `null` if not set or not UTF16 extended
`static int`	`getMaxRecordLength()`
`static int`	`getMaxStringLength()`
`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).
`short`	`getUnknown1()` Returns unknown1 field - currently unknown.
`void`	`setCommand(java.lang.String command)`
`void`	`setCommand2(java.lang.String command2)` Set Command string for UTF16 extended OLE packages or `null` if not set or not UTF16 extended
`void`	`setDataBuffer(byte[] dataBuffer)`
`void`	`setFileName(java.lang.String fileName)`
`void`	`setFileName2(java.lang.String fileName2)` Set filename string for UTF16 extended OLE packages or `null` if not set or not UTF16 extended
`void`	`setFlags1(short flags1)`
`void`	`setFlags2(short flags2)`
`void`	`setLabel(java.lang.String label)`
`void`	`setLabel2(java.lang.String label2)` Set Label string for UTF16 extended OLE packages or `null` if not set or not UTF16 extended
`static void`	`setMaxRecordLength(int length)`
`static void`	`setMaxStringLength(int length)`
`void`	`setUnknown1(short unknown1)`
`void`	`writeOut(java.io.OutputStream out)` Have the contents printer out into an OutputStream, used when writing a file back out to disk (Normally, atom classes will keep their bytes around, but non atom classes will just request the bytes from their children, then chuck on their header and return)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OLE10_NATIVE
```
public static final java.lang.String OLE10_NATIVE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Ole10Native
```
public Ole10Native(java.lang.String label,
                   java.lang.String filename,
                   java.lang.String command,
                   byte[] data)
```
    Creates an instance and fills the fields based on ... the fields
  - Ole10Native
```
public Ole10Native(byte[] data,
                   int offset)
            throws Ole10NativeException
```
    Creates an instance and fills the fields based on the data in the given buffer.
    
    Parameters:
    
    data - The buffer containing the Ole10Native record
    
    offset - The start offset of the record in the buffer
    
    Throws:
    
    Ole10NativeException - on invalid or unexcepted data format
- Method Detail
  - createFromEmbeddedOleObject
```
public static Ole10Native createFromEmbeddedOleObject(POIFSFileSystem poifs)
                                               throws java.io.IOException,
                                                      Ole10NativeException
```
    Creates an instance of this class from an embedded OLE Object. The OLE Object is expected to include a stream "{01}Ole10Native" which contains the actual data relevant for this class.
    
    Parameters:
    
    poifs - POI Filesystem object
    
    Returns:
    
    Returns an instance of this class
    
    Throws:
    
    java.io.IOException - on IO error
    
    Ole10NativeException - on invalid or unexcepted data format
  - createFromEmbeddedOleObject
```
public static Ole10Native createFromEmbeddedOleObject(DirectoryNode directory)
                                               throws java.io.IOException,
                                                      Ole10NativeException
```
    Creates an instance of this class from an embedded OLE Object. The OLE Object is expected to include a stream "{01}Ole10Native" which contains the actual data relevant for this class.
    
    Parameters:
    
    directory - POI Filesystem object
    
    Returns:
    
    Returns an instance of this class
    
    Throws:
    
    java.io.IOException - on IO error
    
    Ole10NativeException - on invalid or unexcepted data format
  - setMaxRecordLength
```
public static void setMaxRecordLength(int length)
```
    Parameters:
    
    length - the max record length allowed for Ole10Native
  - getMaxRecordLength
```
public static int getMaxRecordLength()
```
    Returns:
    
    the max record length allowed for Ole10Native
  - setMaxStringLength
```
public static void setMaxStringLength(int length)
```
    Parameters:
    
    length - the max string length allowed for Ole10Native
  - getMaxStringLength
```
public static int getMaxStringLength()
```
    Returns:
    
    the max string length allowed for Ole10Native
  - createOleMarkerEntry
```
public static void createOleMarkerEntry(DirectoryEntry parent)
                                 throws java.io.IOException
```
    Add the \1OLE marker entry, which is not the Ole10Native entry. Beside this "Ole" record there were several other records, e.g. CompObj, OlePresXXX, but it seems, that they aren't necessary
    
    Throws:
    
    java.io.IOException
  - createOleMarkerEntry
```
public static void createOleMarkerEntry(POIFSFileSystem poifs)
                                 throws java.io.IOException
```
    Add the \1OLE marker entry, which is not the Ole10Native entry. Beside this "Ole" record there were several other records, e.g. CompObj, OlePresXXX, but it seems, that they aren't necessary
    
    Throws:
    
    java.io.IOException
  - getTotalSize
```
public 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).
    
    Returns:
    
    the totalSize
  - getFlags1
```
public short getFlags1()
```
    Returns flags1 - currently unknown - usually 0x0002.
    
    Returns:
    
    the flags1
  - getLabel
```
public 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.
    
    Returns:
    
    the label
  - getFileName
```
public java.lang.String getFileName()
```
    Returns the fileName field - usually the name of the file being embedded including the full path.
    
    Returns:
    
    the fileName
  - getFlags2
```
public short getFlags2()
```
    Returns flags2 - currently unknown - mostly 0x0000.
    
    Returns:
    
    the flags2
  - getUnknown1
```
public short getUnknown1()
```
    Returns unknown1 field - currently unknown.
    
    Returns:
    
    the unknown1
  - getCommand
```
public 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.
    
    Returns:
    
    the command
  - getDataSize
```
public int getDataSize()
```
    Returns the size of the embedded file. If the size is 0 (zero), no data has been embedded. To be sure, that no data has been embedded, check whether getDataBuffer() returns null.
    
    Returns:
    
    the dataSize
  - getDataBuffer
```
public byte[] getDataBuffer()
```
    Returns the buffer containing the embedded file's data, or 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.)
    
    Returns:
    
    the dataBuffer
  - writeOut
```
public void writeOut(java.io.OutputStream out)
              throws java.io.IOException
```
    Have the contents printer out into an OutputStream, used when writing a file back out to disk (Normally, atom classes will keep their bytes around, but non atom classes will just request the bytes from their children, then chuck on their header and return)
    
    Throws:
    
    java.io.IOException
  - setFlags1
```
public void setFlags1(short flags1)
```
  - setFlags2
```
public void setFlags2(short flags2)
```
  - setLabel
```
public void setLabel(java.lang.String label)
```
  - setFileName
```
public void setFileName(java.lang.String fileName)
```
  - setCommand
```
public void setCommand(java.lang.String command)
```
  - setUnknown1
```
public void setUnknown1(short unknown1)
```
  - setDataBuffer
```
public void setDataBuffer(byte[] dataBuffer)
```
  - getCommand2
```
public java.lang.String getCommand2()
```
    Get Command string of UTF16 extended OLE packages or null if not set or not UTF16 extended
  - setCommand2
```
public void setCommand2(java.lang.String command2)
```
    Set Command string for UTF16 extended OLE packages or null if not set or not UTF16 extended
  - getLabel2
```
public java.lang.String getLabel2()
```
    Get Label string for UTF16 extended OLE packages or null if not set or not UTF16 extended
  - setLabel2
```
public void setLabel2(java.lang.String label2)
```
    Set Label string for UTF16 extended OLE packages or null if not set or not UTF16 extended
  - getFileName2
```
public java.lang.String getFileName2()
```
    Get filename string for UTF16 extended OLE packages or null if not set or not UTF16 extended
  - setFileName2
```
public void setFileName2(java.lang.String fileName2)
```
    Set filename string for UTF16 extended OLE packages or null if not set or not UTF16 extended

Class Ole10Native

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OLE10_NATIVE

Constructor Detail

Ole10Native

Ole10Native

Method Detail

createFromEmbeddedOleObject

createFromEmbeddedOleObject

setMaxRecordLength

getMaxRecordLength

setMaxStringLength

getMaxStringLength

createOleMarkerEntry

createOleMarkerEntry

getTotalSize

getFlags1

getLabel

getFileName

getFlags2

getUnknown1

getCommand

getDataSize

getDataBuffer

writeOut

setFlags1

setFlags2

setLabel

setFileName

setCommand

setUnknown1

setDataBuffer

getCommand2

setCommand2

getLabel2

setLabel2

getFileName2

setFileName2