it.stefanochizzolini.clown.tokens
Class Parser

java.lang.Object
  it.stefanochizzolini.clown.tokens.Parser

All Implemented Interfaces:

Closeable

public class Parser
extends Object
implements Closeable

Token parser.

Contract

• Preconditions:
  1. (none).
• Postconditions:
  1. (none).
• Invariants:
  1. Stream data IS kept untouched.
• Side-effects:
  1. (none).

Version:

0.0.8

Author:

Stefano Chizzolini (http://www.stefanochizzolini.it)

Nested Class Summary

class

Parser.Reference

Method Summary

void	close()
protected void	finalize()
long	getLength()
long	getPosition()
IInputStream	getStream()
Object	getToken() Gets the currently-parsed token.
TokenTypeEnum	getTokenType() Gets the currently-parsed token type.
int	hashCode()
protected static boolean	isDelimiter(int c) Evaluates whether a character is a delimiter [PDF:1.6:3.1.1].
protected static boolean	isEOL(int c) Evaluates whether a character is an EOL marker [PDF:1.6:3.1.1].
protected static boolean	isWhitespace(int c) Evaluates whether a character is a white-space [PDF:1.6:3.1.1].
boolean	moveNext() Parse the next token [PDF:1.6:3.1].
boolean	moveNext(int offset)
PdfDataObject	parsePdfObject() Parse the current PDF object [PDF:1.6:3.2].
String	retrieveVersion() Retrieves the PDF version of the file [PDF:1.6:3.4.1].
long	retrieveXRefOffset() Retrieves the starting position of the last xref-table section.
long	retrieveXRefOffset(long offset) Retrieves the starting position of an xref-table section [PDF:1.6:3.4.4].
void	seek(long position)
void	skip(long offset)
boolean	skipWhitespace() Moves to the last whitespace after the current position in order to let read the first non-whitespace.

Methods inherited from class java.lang.Object

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

Method Detail

isDelimiter

protected static boolean isDelimiter(int c)

Evaluates whether a character is a delimiter [PDF:1.6:3.1.1].

isEOL

protected static boolean isEOL(int c)

Evaluates whether a character is an EOL marker [PDF:1.6:3.1.1].

isWhitespace

protected static boolean isWhitespace(int c)

Evaluates whether a character is a white-space [PDF:1.6:3.1.1].

getLength

public long getLength()

getPosition

public long getPosition()

getStream

public IInputStream getStream()

getToken

public Object getToken()

Gets the currently-parsed token.

Returns:

The current token.

getTokenType

public TokenTypeEnum getTokenType()

Gets the currently-parsed token type.

Returns:

The current token type.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

moveNext

public boolean moveNext(int offset)
                 throws FileFormatException

Parameters:

offset - Number of tokens to be skipped before reaching the intended one.

Throws:

FileFormatException

moveNext

public boolean moveNext()
                 throws FileFormatException

Parse the next token [PDF:1.6:3.1].

Contract

• Preconditions:
  1. To properly parse the current token, the pointer MUST be just before its starting (leading whitespaces are ignored).
• Postconditions:
  1. When this method terminates, the pointer IS at the last byte of the current token.
• Invariants:
  1. The byte-level position of the pointer IS anytime (during token parsing) at the end of the current token (whereas the 'current token' represents the token-level position of the pointer).
• Side-effects:
  1. See Postconditions.

Returns:

Whether a new token was found.

Throws:

FileFormatException

parsePdfObject

public PdfDataObject parsePdfObject()
                             throws FileFormatException

Parse the current PDF object [PDF:1.6:3.2].

Contract

• Preconditions:
  1. When this method is invoked, the pointer MUST be at the first token of the requested object.
• Postconditions:
  1. When this method terminates, the pointer IS at the last token of the requested object.
• Invariants:
  1. (none).
• Side-effects:
  1. See Postconditions.

Throws:

FileFormatException

retrieveVersion

public String retrieveVersion()
                       throws FileFormatException

Retrieves the PDF version of the file [PDF:1.6:3.4.1].

Contract

• Preconditions:
  1. (none).
• Postconditions:
  1. (none).
• Invariants:
  1. (none).
• Side-effects:
  1. The pointer is released at an undefined location.

Throws:

FileFormatException

retrieveXRefOffset

public long retrieveXRefOffset()
                        throws FileFormatException

Retrieves the starting position of the last xref-table section.

Throws:

FileFormatException

See Also:

retrieveXRefOffset(long)

retrieveXRefOffset

public long retrieveXRefOffset(long offset)
                        throws FileFormatException

Retrieves the starting position of an xref-table section [PDF:1.6:3.4.4].

Contract

• Preconditions:
  1. (none).
• Postconditions:
  1. (none).
• Invariants:
  1. (none).
• Side-effects:
  1. The pointer is released at an undefined location.

Parameters:

offset - Position of the EOF marker related to the section intended to be parsed.

Throws:

FileFormatException

seek

public void seek(long position)

skip

public void skip(long offset)

skipWhitespace

public boolean skipWhitespace()

Moves to the last whitespace after the current position in order to let read the first non-whitespace.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Throws:

IOException

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable