| java.lang.Object | |||
| ↳ | com.pdftron.filters.Filter | ||
| ↳ | com.pdftron.filters.CustomFilter | ||
| ↳ | com.pdftron.filters.SecondaryFileFilter | ||
Class Overview
This class is used for creating a PDFDoc from Android content Uri.
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From class
com.pdftron.filters.CustomFilter
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| SecondaryFileFilter(Context context, Uri treeUri) | |||||||||||
| SecondaryFileFilter(Context context, Uri treeUri, int mode) | |||||||||||
| SecondaryFileFilter(int mode, SecondaryFileFilter attached) | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static SecondaryFileFilter | __Create(long impl, SecondaryFileFilter prev) | ||||||||||
| void | cleanup() | ||||||||||
| void |
close()
Frees the native memory of the object.
| ||||||||||
| SecondaryFileFilter | createOutputIterator() | ||||||||||
| void | force(boolean metadata) | ||||||||||
| int | getRawSequenceNumber() | ||||||||||
| String | getSequenceNumber() | ||||||||||
| long | onCreateInputIterator(Object o) | ||||||||||
| void | onDestroy(Object o) | ||||||||||
| long |
onFlush(Object o)
The abstract function in which the output data is flushed.
| ||||||||||
| long |
onRead(byte[] bytes, Object o)
The abstract function in which the input data are read.
| ||||||||||
| long |
onSeek(long offset, int origin, Object o)
The abstract function in which the position indicator of the filter is
set.
| ||||||||||
| long |
onTell(Object o)
The abstract function in which the position indicator of the filter is
queried.
| ||||||||||
| long |
onTruncate(long new_size, Object user_object)
The abstract function the size of the filter is set
| ||||||||||
| long |
onWrite(byte[] bytes, Object o)
The abstract function in which the data are output.
| ||||||||||
| long |
size()
Returns the size of buffer returned by Begin().
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.pdftron.filters.CustomFilter
| |||||||||||
|
From class
com.pdftron.filters.Filter
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
java.lang.AutoCloseable
| |||||||||||
Public Constructors
public SecondaryFileFilter (Context context, Uri treeUri)
Throws
| FileNotFoundException | |
|---|---|
| PDFNetException |
public SecondaryFileFilter (Context context, Uri treeUri, int mode)
Throws
| FileNotFoundException | |
|---|---|
| PDFNetException |
public SecondaryFileFilter (int mode, SecondaryFileFilter attached)
Throws
| IOException | |
|---|---|
| PDFNetException |
Public Methods
public static SecondaryFileFilter __Create (long impl, SecondaryFileFilter prev)
Throws
| IOException | |
|---|---|
| PDFNetException |
public void cleanup ()
public void close ()
Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.
public void force (boolean metadata)
Throws
| IOException |
|---|
public int getRawSequenceNumber ()
public String getSequenceNumber ()
public long onCreateInputIterator (Object o)
public void onDestroy (Object o)
public long onFlush (Object o)
The abstract function in which the output data is flushed.
Parameters
| o | The user data from passed in via #CustomFilter(int, Object). |
|---|
Returns
- If successful, the value is 0; otherwise, it is non-zero.
public long onRead (byte[] bytes, Object o)
The abstract function in which the input data are read.
Parameters
| bytes | The buffer to contain the data to read, which has already been allocated. |
|---|---|
| o | The user data from passed in via #CustomFilter(int, Object). |
Returns
- The number of bytes read. It should return 0 if it fails or reaches the end of the input stream.
public long onSeek (long offset, int origin, Object o)
The abstract function in which the position indicator of the filter is set.
Parameters
| offset | Number of bytes to offset from origin. A positive value implies the indicator is moved forward, and a negative value implies the indicator is moved backward. |
|---|---|
| origin | Position from where offset is added. It is specified by one of
the following: SEEK_SET,
SEEK_CUR, SEEK_END. |
| o | The user data from passed in via #CustomFilter(int, Object). |
Returns
- The new position of the indicator set. If successful, the value is 0; otherwise, it is non-zero.
public long onTell (Object o)
The abstract function in which the position indicator of the filter is queried.
Parameters
| o | The user data from passed in via #CustomFilter(int, Object). |
|---|
Returns
- The position of the indicator.
public long onTruncate (long new_size, Object user_object)
The abstract function the size of the filter is set
Parameters
| new_size | number of bytes to resize the filter to. |
|---|---|
| user_object | The user data from passed in via #CustomFilter(int, Object). |
Returns
- The new size of the filter.
public long onWrite (byte[] bytes, Object o)
The abstract function in which the data are output.
Parameters
| bytes | The buffer to contain the data to write out. |
|---|---|
| o | The user data from passed in via #CustomFilter(int, Object). |
Returns
- The number of bytes successfully written.
public long size ()
Returns the size of buffer returned by Begin(). If the Size() returns 0 end of data has been reached.
Returns
- - the size of buffer returned by Begin(). If the Size() returns 0 end of data has been reached.
Throws
| PDFNetException |
|---|