Class PDFParser

java.lang.Object

com.sun.pdfview.BaseWatchable

com.sun.pdfview.PDFParser

All Implemented Interfaces:

Watchable, Runnable

public class PDFParser
extends BaseWatchable

PDFParser is the class that parses a PDF content stream and produces PDFCmds for a PDFPage. You should never ever see it run: it gets created by a PDFPage only if needed, and may even run in its own thread.

Author:

Mike Wessler

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEBUG_DCTDECODE_DATA	emit a file of DCT stream data.
static int	debuglevel

Fields inherited from interface Watchable

COMPLETED, ERROR, NEEDS_DATA, NOT_STARTED, PAUSED, RUNNING, STOPPED, UNKNOWN

Constructor Summary

Constructors

Constructor	Description
PDFParser(PDFPage cmds, byte[] stream, HashMap<String, PDFObject> resources)	Don't call this constructor directly.

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Cleanup when iteration is done
static void	debug(String msg, int level)
String	dumpStream()
void	dumpStreamToError()
static void	emitDataFile(byte[] ary, String name)	take a byte array and write a temporary file with it's data.
static String	escape(String msg)
int	iterate()	parse the stream.
static void	setDebugLevel(int level)
void	setup()	Called to prepare for some iterations

Methods inherited from class BaseWatchable

execute, getStatus, go, go, go, go, isExecutable, isFinished, isSuppressSetErrorStackTrace, run, setError, setStatus, setSuppressSetErrorStackTrace, stop, waitForFinish

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEBUG_DCTDECODE_DATA

public static final String DEBUG_DCTDECODE_DATA

emit a file of DCT stream data.

See Also:

• Constant Field Values

debuglevel

public static int debuglevel

Constructor Details

PDFParser

public PDFParser(PDFPage cmds,
 byte[] stream,
 HashMap<String, PDFObject> resources)

Don't call this constructor directly. Instead, use PDFFile.getPage(int pagenum) to get a PDFPage. There should never be any reason for a user to create, access, or hold on to a PDFParser.

Method Details

debug

public static void debug(String msg,
 int level)

escape

public static String escape(String msg)

setDebugLevel

public static void setDebugLevel(int level)

setup

public void setup()

Called to prepare for some iterations

Overrides:

setup in class BaseWatchable

iterate

public int iterate()
            throws Exception

parse the stream. commands are added to the PDFPage initialized in the constructor as they are encountered.

Page numbers in comments refer to the Adobe PDF specification.
commands are listed in PDF spec 32000-1:2008 in Table A.1

Specified by:

iterate in class BaseWatchable

Returns:

• Watchable.RUNNING when there are commands to be processed
• Watchable.COMPLETED when the page is done and all the commands have been processed
• Watchable.STOPPED if the page we are rendering into is no longer available

Throws:

Exception

cleanup

public void cleanup()

Cleanup when iteration is done

Overrides:

cleanup in class BaseWatchable

dumpStreamToError

public void dumpStreamToError()

dumpStream

public String dumpStream()

emitDataFile

public static void emitDataFile(byte[] ary,
 String name)

take a byte array and write a temporary file with it's data. This is intended to capture data for analysis, like after decoders.

Parameters:

ary -

name -