Uses of Interface org.apache.pdfbox.io.SequentialRead (Apache PDFBox 2.0.0-SNAPSHOT API)

Frames

Frames

org.apache.pdfbox.io Class Hierarchy (Apache PDFBox 2.0.0-SNAPSHOT API)

Frames

Frames

Uses of Package org.apache.pdfbox.io (Apache PDFBox 2.0.0-SNAPSHOT API)

A simple subclass that adds a few convience methods.

RandomAccess

An interface to allow PDF files to be stored completely in memory or - to use a scratch file on the disk.

BaseParser (Apache PDFBox 2.0.0-SNAPSHOT API)

Prev Class
Next Class
Next Class

Frames

+
All Implemented Interfaces:
+
Closeable, AutoCloseable
+
+

Direct Known Subclasses:
-
ConformingPDFParser, PDFObjectStreamParser, PDFParser, PDFStreamParser, PDFXrefStreamParser, VisualSignatureParser
+
COSParser, PDFObjectStreamParser, PDFStreamParser, PDFXrefStreamParser, VisualSignatureParser
```
public abstract class BaseParser
-extends Object
```
+extends Object +implements Closeable
This class is used to contain parsing logic that will be used by both the PDFParser and the COSStreamParser.
-
Version:
-
$Revision$
-
Author:
-
Ben Litchfield
+
Author:
+
Ben Litchfield

Field and Description +protected static byte +

ASCII_CR

ASCII code for carriage return.

protected static byte

ASCII_LF

ASCII code for line feed.

static String

DEF

This is a string constant that will be used for comparisons.

+protected static

String

ENDOBJ_STRING

This is a string constant that will be used for comparisons.

static byte[]

ENDSTREAM

This is a byte array that will be used for comparisons.

protected static String

ENDSTREAM_STRING

This is a string constant that will be used for comparisons.

static String

ISO_8859_1

String constant for ISO-8859-1 charset.

protected PushBackInputStream

pdfSource

This is the stream that will be read from.

static String

PROP_PUSHBACK_SIZE

system property allowing to define size of push back buffer.

protected static String

STREAM_STRING

This is a string constant that will be used for comparisons.

@@ -213,9 +252,7 @@ extends void -clearResources() -

Release all used resources.

- +close() protected COSStream @@ -237,6 +274,18 @@ extends protected boolean +isDigit() +

This will tell if the next byte is a digit or not.

+ + + +protected boolean +isDigit(int c) +

This will tell if the given value is a digit or not.

+ + + +protected boolean isEndOfName(char ch)

Determine if a character terminates a PDF name.

@@ -255,6 +304,30 @@ extends protected boolean +isSpace() +

This will tell if the next byte is a space or not.

+ + + +protected boolean +isSpace(int c) +

This will tell if the given value is a space or not.

+ + + +protected boolean +isString(byte[] string) +

Checks if the given string can be found at the current offset.

+ + + +protected boolean +isString(char[] string) +

Checks if the given string can be found at the current offset.

+ + + +protected boolean isWhitespace()

This will tell if the next byte is whitespace or not.

@@ -262,7 +335,7 @@ extends protected boolean isWhitespace(int c) -

This will tell if the next byte is whitespace or not.

This will tell if a character is whitespace or not.

@@ -302,34 +375,33 @@ extends -protected COSString -parseCOSString(boolean isDictionary) -

Deprecated. -

Not needed anymore. Use parseCOSString() instead. PDFBOX-1437

- - - protected COSBase parseDirObject()

This will parse a directory object from the stream.

- -protected COSObjectKey + +protected COSObjectKey parseObjectKey(boolean continueOnError)

Parse object key (number and generation).

- + protected void readExpectedChar(char ec)

Read one char and throw an exception if it is not the expected value.

+ +protected void +

readExpectedString(char[] expectedString,
+                  boolean skipSpaces)

Reads given pattern from pdfSource.

+ + protected void -readExpectedString(String es) +readExpectedString(String expectedString)

Read one String and throw an exception if it is not the expected value.

@@ -394,18 +466,12 @@ extends -void -setDocument(COSDocument doc) -

Set the document for this stream.

- - - protected void skipSpaces()

This will skip all spaces and comments that are present.

- + protected void skipToNextObj()

Skip to the start of the next object.

@@ -433,6 +499,17 @@ extends + + +

+
ISO_8859_1
+
```
public static final String ISO_8859_1
```
+
String constant for ISO-8859-1 charset.
+
See Also:
Constant Field Values
+

@@ -475,6 +552,61 @@ extends See Also:

Constant Field Values

+ + + +

+
ENDOBJ_STRING
+
```
protected static final String ENDOBJ_STRING
```
+
This is a string constant that will be used for comparisons.
+
See Also:
Constant Field Values
+

+ + + +

+
ENDSTREAM_STRING
+
```
protected static final String ENDSTREAM_STRING
```
+
This is a string constant that will be used for comparisons.
+
See Also:
Constant Field Values
+

+ + + +

+
STREAM_STRING
+
```
protected static final String STREAM_STRING
```
+
This is a string constant that will be used for comparisons.
+
See Also:
Constant Field Values
+

+ + + +

+
ASCII_LF
+
```
protected static final byte ASCII_LF
```
+
ASCII code for line feed.
+
See Also:
Constant Field Values
+

+ + + +

+
ASCII_CR
+
```
protected static final byte ASCII_CR
```
+
ASCII code for carriage return.
+
See Also:
Constant Field Values
+

@@ -561,17 +693,6 @@ extends Returns:

the new COSStream

- - - -

-
setDocument
-
```
public void setDocument(COSDocument doc)
```
-
Set the document for this stream.
-
Parameters:
doc - The current document.
-

@@ -619,24 +740,7 @@ extends Parameters:

out - stream we write out to.

Throws:

IOException

- -

- - - -

-
parseCOSString
-
```
@Deprecated
-protected COSString parseCOSString(boolean isDictionary)
-                            throws IOException
```
-
Deprecated. Not needed anymore. Use parseCOSString() instead. PDFBOX-1437
-
This will parse a PDF string.
-
Parameters:
isDictionary - indicates if the stream is a dictionary or not
-
Returns:
The parsed PDF string.
-
Throws:
-
IOException - If there is an error reading from the stream.
+
IOException - if something went wrong

@@ -741,15 +845,30 @@ protected

readExpectedString

protected void readExpectedString(String es)
+protected void readExpectedString(String expectedString)
                            throws IOException
 Read one String and throw an exception if it is not the expected value.
-Parameters:
es - the String value that is expected.
+Parameters:
expectedString - the String value that is expected.
 Throws:
 IOException - if the String char is not the expected value or if an
  I/O error occurs.

+ + + +

+
readExpectedString
+
```
protected final void readExpectedString(char[] expectedString,
+                      boolean skipSpaces)
+                                 throws IOException
```
+
Reads given pattern from pdfSource. Skipping whitespace at start and end if wanted.
+
Parameters:
expectedString - pattern to be skipped
skipSpaces - if set to true spaces before and after the string will be skipped
+
Throws:
+
IOException - if pattern could not be read
+

@@ -815,8 +934,8 @@ protected String readLine() throws IOException

This will read bytes until the first end of line marker occurs. - Note: if you later unread the results of this function, you'll - need to add a newline character to the end of the string.

+ NOTE: The EOL marker may consists of 1 (CR or LF) or 2 (CR and CL) bytes + which is an important detail if one wants to unread the line.

This will tell if the next byte is whitespace or not. These values are +

This will tell if a character is whitespace or not. These values are specified in table 1 (page 12) of ISO 32000-1:2008.

Parameters:: c - The character to check against whitespace
Returns:: true if the next byte in the stream is a whitespace character.

Returns:

true if the character is a whitespace character.

+ + + + + +

+
isSpace
+
```
protected boolean isSpace()
+                   throws IOException
```
+
This will tell if the next byte is a space or not.
+
Returns:
true if the next byte in the stream is a space character.
+
Throws:
+
IOException - If there is an error reading from the stream.
+

+ + + +

+
isSpace
+
```
protected boolean isSpace(int c)
```
+
This will tell if the given value is a space or not.
+
Parameters:
c - The character to check against space
+
Returns:
true if the next byte in the stream is a space character.
+

+ + + +

+
isDigit
+
```
protected boolean isDigit()
+                   throws IOException
```
+
This will tell if the next byte is a digit or not.
+
Returns:
true if the next byte in the stream is a digit.
+
Throws:
+
IOException - If there is an error reading from the stream.
+

+ + + +

+
isDigit
+
```
protected boolean isDigit(int c)
```
+
This will tell if the given value is a digit or not.
+
Parameters:
c - The character to be checked
+
Returns:
true if the next byte in the stream is a digit.
+

+ + + +

+
isString
+
```
protected boolean isString(byte[] string)
+                    throws IOException
```
+
Checks if the given string can be found at the current offset.
+
Parameters:
string - the bytes of the string to look for
+
Returns:
true if the bytes are in place, false if not
+
Throws:
+
IOException - if something went wrong
+

+ + + +

+
isString
+
```
protected boolean isString(char[] string)
+                    throws IOException
```
+
Checks if the given string can be found at the current offset.
+
Parameters:
string - the bytes of the string to look for
+
Returns:
true if the bytes are in place, false if not
+
Throws:
+
IOException - if something went wrong

@@ -974,17 +1175,24 @@ protected Throws: -

IOException

IOException - if something went wrong.

- +

-
clearResources
-
```
public void clearResources()
```
-
Release all used resources.
+
close
+
```
public void close()
+           throws IOException
```
+
+
Specified by:
+
close in interface Closeable
+
Specified by:
+
close in interface AutoCloseable
+
Throws:
+
IOException

@@ -993,7 +1201,7 @@ protected

parseObjectKey

protected COSObjectKey parseObjectKey(boolean continueOnError)
+protected COSObjectKey parseObjectKey(boolean continueOnError)
                                throws IOException
 Parse object key (number and generation).
 Parameters:
continueOnError - true to continue on error, false if not.
@@ -1029,7 +1237,7 @@ protected 
 
 Prev Class
-Next Class
+Next Class
 
 
 Frames

Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdfparser/PDFObjectStreamParser.html
URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdfparser/PDFObjectStreamParser.html?rev=1669997&r1=1669996&r2=1669997&view=diff
==============================================================================
--- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdfparser/PDFObjectStreamParser.html (original)
+++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdfparser/PDFObjectStreamParser.html Mon Mar 30 05:51:10 2015
@@ -2,10 +2,10 @@
 
 
 
-
+
 
 PDFObjectStreamParser (Apache PDFBox 2.0.0-SNAPSHOT API)
-
+
 
 
 
@@ -37,7 +37,7 @@