org.apache.pdfbox.pdfparser

Class PDFStreamParser

java.lang.Object

org.apache.pdfbox.pdfparser.BaseParser

org.apache.pdfbox.pdfparser.PDFStreamParser

public class PDFStreamParser
extends BaseParser

This will parse a PDF byte stream and extract operands and such.

Author:

Ben Litchfield

Field Summary

Fields inherited from class org.apache.pdfbox.pdfparser.BaseParser

A, ASCII_CR, ASCII_LF, ASCII_SPACE, B, D, DEF, document, E, ENDOBJ_STRING, ENDSTREAM_STRING, J, M, N, O, pdfSource, PROP_PUSHBACK_SIZE, R, S, STREAM_STRING, T, validationParsing

Constructor Summary

Constructors

Constructor and Description
PDFStreamParser(COSStream stream) Constructor.
PDFStreamParser(COSStream stream, boolean validationParsing) Constructor.
PDFStreamParser(PDStream stream) Constructor.
PDFStreamParser(RandomAccessRead input) Constructor.

Method Summary

Modifier and Type	Method and Description
Iterator<Object>	getTokenIterator() This will get an iterator which can be used to parse the stream one token after the other.
List<Object>	getTokens() This will get the tokens that were parsed from the stream.
void	parse() This will parse the tokens in the stream.
Object	parseNextToken() This will parse the next token in the stream.
protected String	readOperator() This will read an operator from the stream.

Methods inherited from class org.apache.pdfbox.pdfparser.BaseParser

isClosing, isClosing, isDigit, isDigit, isEndOfName, isEOL, isEOL, isSpace, isSpace, isWhitespace, isWhitespace, parseBoolean, parseCOSArray, parseCOSDictionary, parseCOSName, parseCOSString, parseDirObject, readExpectedChar, readExpectedString, readExpectedString, readGenerationNumber, readInt, readLine, readLineWithoutWhitespacesSkip, readLong, readObjectNumber, readString, readString, readStringNumber, skipSpaces, skipWhiteSpaces

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFStreamParser

public PDFStreamParser(PDStream stream)
                throws IOException

Constructor.

Parameters:

stream - The stream to parse.

Throws:

IOException - If there is an error initializing the stream.

PDFStreamParser

public PDFStreamParser(COSStream stream)
                throws IOException

Constructor.

Parameters:

stream - The stream to parse.

Throws:

IOException - If there is an error initializing the stream.

PDFStreamParser

public PDFStreamParser(COSStream stream,
                       boolean validationParsing)
                throws IOException

Constructor.

Parameters:

stream - The stream to parse.

validationParsing - flag to parse according to pdfa validation

Throws:

IOException - If there is an error initializing the stream.

PDFStreamParser

public PDFStreamParser(RandomAccessRead input)
                throws IOException

Constructor.

Parameters:

input - The random access read to parse.

Throws:

IOException - If there is an error initializing the stream.

Method Detail

parse

public void parse()
           throws IOException

This will parse the tokens in the stream. This will close the stream when it is finished parsing.

Throws:

IOException - If there is an error while parsing the stream.

getTokens

public List<Object> getTokens()

This will get the tokens that were parsed from the stream.

Returns:

All of the tokens in the stream.

getTokenIterator

public Iterator<Object> getTokenIterator()

This will get an iterator which can be used to parse the stream one token after the other.

Returns:

an iterator to get one token after the other

parseNextToken

public Object parseNextToken()
                      throws IOException

This will parse the next token in the stream.

Returns:

The next token in the stream or null if there are no more tokens in the stream.

Throws:

IOException - If an io error occurs while parsing the stream.

readOperator

protected String readOperator()
                       throws IOException

This will read an operator from the stream.

Returns:

The operator that was read from the stream.

Throws:

IOException - If there is an error reading from the stream.