public class

FileDescriptorFilter

extends CustomFilter
implements AutoCloseable
java.lang.Object
   ↳ com.pdftron.filters.Filter
     ↳ com.pdftron.filters.CustomFilter
       ↳ com.pdftron.filters.FileDescriptorFilter

Summary

[Expand]
Inherited Constants
From class com.pdftron.filters.CustomFilter
Public Constructors
FileDescriptorFilter(int mode, Object obj)
Public Methods
static FileDescriptorFilter __Create(long impl, FileDescriptorFilter prev)
boolean canWriteOnInputFilter()
void close()
Frees the native memory of the object.
FileDescriptorFilter createOutputIterator()
int getThreadId()
long onCreateInputIterator(Object user_object)
void onDestroy(Object user_object)
long onFlush(Object user_object)
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 user_object)
The abstract function in which the position indicator of the filter is set.
long onTell(Object user_object)
The abstract function in which the position indicator of the filter is queried.
long onWrite(byte[] buf, Object user_object)
The abstract function in which the data are output.
boolean switchToWriteMode()
[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 FileDescriptorFilter (int mode, Object obj)

Throws
PDFNetException

Public Methods

public static FileDescriptorFilter __Create (long impl, FileDescriptorFilter prev)

public boolean canWriteOnInputFilter ()

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 FileDescriptorFilter createOutputIterator ()

public int getThreadId ()

public long onCreateInputIterator (Object user_object)

public void onDestroy (Object user_object)

public long onFlush (Object user_object)

The abstract function in which the output data is flushed.

Parameters
user_object 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 user_object)

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.
user_object 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 user_object)

The abstract function in which the position indicator of the filter is queried.

Parameters
user_object The user data from passed in via #CustomFilter(int, Object).
Returns
  • The position of the indicator.

public long onWrite (byte[] buf, Object user_object)

The abstract function in which the data are output.

Parameters
buf The buffer to contain the data to write out.
user_object The user data from passed in via #CustomFilter(int, Object).
Returns
  • The number of bytes successfully written.

public boolean switchToWriteMode ()