Uses of Class org.apache.pdfbox.filter.LZWFilter (Apache PDFBox 1.8.10 API)

org.apache.pdfbox.filter

org.apache.pdfbox.filter (Apache PDFBox 1.8.10 API)

+ + + + + + + + + + + + +
Interface Summary
Interface Description
Filter +
This is the interface that will be used to apply filters to a byte stream.
+
+

Interface Summary
Interface	Description
Filter	+ This is the interface that will be used to apply filters to a byte stream. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Class Summary
Class	Description
ASCII85Filter	+ This is the used for the ASCIIHexDecode filter. +
ASCIIHexFilter	+ This is the used for the ASCIIHexDecode filter. +
CCITTFaxDecodeFilter	+ This is a filter for the CCITTFax Decoder. +
CryptFilter
DCTFilter	+ This is the used for the DCTDecode filter. +
FilterManager	+ This will contain manage all the different types of filters that are available. +
FlateFilter	+ This is the used for the FlateDecode filter. +
IdentityFilter	+ The IdentityFilter filter just passes the data through without any modifications. +
JBIG2Filter	+ Modeled on the JBIG2Decode filter. +
JPXFilter	+ This is used for the JPXDecode filter. +
LZWFilter	+ This is the filter used for the LZWDecode filter. +
Predictor	+ Helper class to contain predictor decoding used by Flate and LZW filter. +
RunLengthDecodeFilter	+ This is a filter for the RunLength Decoder. +

+ + + +

Package org.apache.pdfbox.filter Description

This package will hold the PDFBox implementations of the filters that are used in PDF documents.

org.apache.pdfbox.filter Class Hierarchy (Apache PDFBox 1.8.10 API)

Class Hierarchy

java.lang.Object +
- org.apache.pdfbox.filter.ASCII85Filter (implements org.apache.pdfbox.filter.Filter)
- org.apache.pdfbox.filter.ASCIIHexFilter (implements org.apache.pdfbox.filter.Filter)
- org.apache.pdfbox.filter.CCITTFaxDecodeFilter (implements org.apache.pdfbox.filter.Filter)
- org.apache.pdfbox.filter.CryptFilter (implements org.apache.pdfbox.filter.Filter)
- org.apache.pdfbox.filter.DCTFilter (implements org.apache.pdfbox.filter.Filter)
- org.apache.pdfbox.filter.FilterManager
- org.apache.pdfbox.filter.FlateFilter (implements org.apache.pdfbox.filter.Filter)
- org.apache.pdfbox.filter.IdentityFilter (implements org.apache.pdfbox.filter.Filter)
- org.apache.pdfbox.filter.JBIG2Filter (implements org.apache.pdfbox.filter.Filter)
- org.apache.pdfbox.filter.JPXFilter (implements org.apache.pdfbox.filter.Filter)
- org.apache.pdfbox.filter.LZWFilter (implements org.apache.pdfbox.filter.Filter)
- org.apache.pdfbox.filter.Predictor
- org.apache.pdfbox.filter.RunLengthDecodeFilter (implements org.apache.pdfbox.filter.Filter)
+

Interface Hierarchy

org.apache.pdfbox.filter.Filter

Uses of Package org.apache.pdfbox.filter (Apache PDFBox 1.8.10 API)

+ + + + + + + + + + + + + + + + +

Packages that use org.apache.pdfbox.filter
Package	Description
org.apache.pdfbox.cos	+ These are the low level objects that make up a PDF document. +
org.apache.pdfbox.filter	+ This package will hold the PDFBox implementations of the filters that are used in PDF documents. +

+ + + + + + + + + + + + +
Classes in org.apache.pdfbox.filter used by org.apache.pdfbox.cos
Class and Description
FilterManager +
This will contain manage all the different types of filters that are available.
+
+
+ + + + + + + + + + + + +
Classes in org.apache.pdfbox.filter used by org.apache.pdfbox.filter
Class and Description
Filter +
This is the interface that will be used to apply filters to a byte stream.
+
+

ASCII85InputStream (Apache PDFBox 1.8.10 API)

Classes in org.apache.pdfbox.filter used by org.apache.pdfbox.cos
Class and Description
FilterManager + This will contain manage all the different types of filters that are available. +

Classes in org.apache.pdfbox.filter used by org.apache.pdfbox.filter
Class and Description
Filter + This is the interface that will be used to apply filters to a byte stream. +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

java.lang.Object
+
- java.io.InputStream
- +
  - java.io.FilterInputStream
  - +
    - org.apache.pdfbox.io.ASCII85InputStream
    +
  +
+

+
+
All Implemented Interfaces:
+
Closeable, AutoCloseable
+
+
+
+
```
public class ASCII85InputStream
+extends FilterInputStream
```
+
This class represents an ASCII85 stream.
+
Author:
+
Ben Litchfield
+

+ +

+ + +
Field Summary
+
- + + +
  Fields inherited from class java.io.FilterInputStream
  +in
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
ASCII85InputStream(InputStream is) +
Constructor.
+
+

Constructors
Constructor and Description
`ASCII85InputStream(InputStream is)` + Constructor. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`int`	`available()` + Unsupported. +
`void`	`close()` + This will close the underlying stream and release any resources. +
`void`	`mark(int readlimit)` + Unsupported. +
`boolean`	`markSupported()` + non supported interface methods. +
`int`	`read()` + This will read the next byte from the stream. +
`int`	`read(byte[] data, + int offset, + int len)` + This will read a chunk of data. +
`void`	`reset()` + Unsupported. +
`long`	`skip(long nValue)` + Unsupported. +

+ + +
Methods inherited from class java.io.FilterInputStream
+read

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

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    ASCII85InputStream
    +
```
public ASCII85InputStream(InputStream is)
```
    +
    Constructor.
    +
    Parameters:
    is - The input stream to actually read from.
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    read
    +
```
public final int read()
+               throws IOException
```
    +
    This will read the next byte from the stream.
    +
    +
    Overrides:
    +
    read in class FilterInputStream
    +
    Returns:
    The next byte read from the stream.
    +
    Throws:
    +
    IOException - If there is an error reading from the wrapped stream.
    +
  + + + +
  - +
    read
    +
```
public final int read(byte[] data,
+       int offset,
+       int len)
+               throws IOException
```
    +
    This will read a chunk of data.
    +
    +
    Overrides:
    +
    read in class FilterInputStream
    +
    Parameters:
    data - The buffer to write data to.
    offset - The offset into the data stream.
    len - The number of byte to attempt to read.
    +
    Returns:
    The number of bytes actually read.
    +
    Throws:
    +
    IOException - If there is an error reading data from the underlying stream.
    +
  + + + +
  - +
    close
    +
```
public void close()
+           throws IOException
```
    +
    This will close the underlying stream and release any resources.
    +
    +
    Specified by:
    +
    close in interface Closeable
    +
    Specified by:
    +
    close in interface AutoCloseable
    +
    Overrides:
    +
    close in class FilterInputStream
    +
    Throws:
    +
    IOException - If there is an error closing the underlying stream.
    +
  + + + +
  - +
    markSupported
    +
```
public boolean markSupported()
```
    +
    non supported interface methods.
    +
    +
    Overrides:
    +
    markSupported in class FilterInputStream
    +
    Returns:
    False always.
    +
  + + + +
  - +
    skip
    +
```
public long skip(long nValue)
```
    +
    Unsupported.
    +
    +
    Overrides:
    +
    skip in class FilterInputStream
    +
    Parameters:
    nValue - ignored.
    +
    Returns:
    Always zero.
    +
  + + + +
  - +
    available
    +
```
public int available()
```
    +
    Unsupported.
    +
    +
    Overrides:
    +
    available in class FilterInputStream
    +
    Returns:
    Always zero.
    +
  + + + +
  - +
    mark
    +
```
public void mark(int readlimit)
```
    +
    Unsupported.
    +
    +
    Overrides:
    +
    mark in class FilterInputStream
    +
    Parameters:
    readlimit - ignored.
    +
  + + + +
  - +
    reset
    +
```
public void reset()
+           throws IOException
```
    +
    Unsupported.
    +
    +
    Overrides:
    +
    reset in class FilterInputStream
    +
    Throws:
    +
    IOException - telling that this is an unsupported action.
    +
  +
+

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +