PDFCharStream

java.lang.Object
- com.inductiveautomation.rm.pdf.reader.PDFCharStream

All Implemented Interfaces:

CharStream
```
public final class PDFCharStream
extends java.lang.Object
implements CharStream
```
An implementation of interface CharStream, where the stream can contain any binary data. It holds a buffer to the entire contents and keeps track of the the current position within that buffer.

Field Summary

Fields
Modifier and Type Field and Description

int bufpos

static boolean staticFlag

Fields
Modifier and Type	Field and Description
`int`	`bufpos`
`static boolean`	`staticFlag`

Constructor Summary

Constructors
Constructor and Description

PDFCharStream(byte[] b)

Constructors
Constructor and Description
`PDFCharStream(byte[] b)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`backup(int amount)` Backs up the input stream by amount steps.
`char`	`BeginToken()` Returns the next character that marks the beginning of the next token.
`byte[]`	`buffer()`
`int`	`currentLocation()`
`void`	`Done()` The lexer calls this function to indicate that it is done with the stream and hence implementations can free any resources held by this class.
`int`	`getBeginColumn()` Returns the column number of the first character for current token (being matched after the last call to BeginTOken).
`int`	`getBeginLine()` Returns the line number of the first character for current token (being matched after the last call to BeginTOken).
`int`	`getColumn()` Returns the column position of the character last read.
`int`	`getEndColumn()` Returns the column number of the last character for current token (being matched after the last call to BeginTOken).
`int`	`getEndLine()` Returns the line number of the last character for current token (being matched after the last call to BeginTOken).
`java.lang.String`	`GetImage()` Returns a string made up of characters from the marked token beginning to the current buffer position.
`int`	`getLine()` Returns the line number of the character last read.
`byte[]`	`GetNextBytes(int n)`
`char[]`	`GetSuffix(int len)` Returns an array of characters that make up the suffix of length 'len' for the currently matched token.
`char`	`readChar()` Returns the next character from the selected input.
`void`	`ReInit(byte[] newdata, int offset)`
`void`	`ReInit(int offset)`

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

- Field Detail
  - staticFlag
```
public static final boolean staticFlag
```
    See Also:
    
    Constant Field Values
  - bufpos
```
public int bufpos
```
- Constructor Detail
  - PDFCharStream
```
public PDFCharStream(byte[] b)
```
- Method Detail
  - readChar
```
public final char readChar()
                    throws java.io.IOException
```
    Description copied from interface: CharStream
    
    Returns the next character from the selected input. The method of selecting the input is the responsibility of the class implementing this interface. Can throw any java.io.IOException.
    
    Specified by:
    
    readChar in interface CharStream
    
    Throws:
    
    java.io.IOException
  - getColumn
```
public int getColumn()
```
    Description copied from interface: CharStream
    
    Returns the column position of the character last read.
    
    Specified by:
    
    getColumn in interface CharStream
    
    See Also:
    
    CharStream.getEndColumn()
  - getLine
```
public int getLine()
```
    Description copied from interface: CharStream
    
    Returns the line number of the character last read.
    
    Specified by:
    
    getLine in interface CharStream
    
    See Also:
    
    CharStream.getEndLine()
  - getEndColumn
```
public int getEndColumn()
```
    Description copied from interface: CharStream
    
    Returns the column number of the last character for current token (being matched after the last call to BeginTOken).
    
    Specified by:
    
    getEndColumn in interface CharStream
  - getEndLine
```
public int getEndLine()
```
    Description copied from interface: CharStream
    
    Returns the line number of the last character for current token (being matched after the last call to BeginTOken).
    
    Specified by:
    
    getEndLine in interface CharStream
  - getBeginColumn
```
public int getBeginColumn()
```
    Description copied from interface: CharStream
    
    Returns the column number of the first character for current token (being matched after the last call to BeginTOken).
    
    Specified by:
    
    getBeginColumn in interface CharStream
  - getBeginLine
```
public int getBeginLine()
```
    Description copied from interface: CharStream
    
    Returns the line number of the first character for current token (being matched after the last call to BeginTOken).
    
    Specified by:
    
    getBeginLine in interface CharStream
  - backup
```
public final void backup(int amount)
```
    Description copied from interface: CharStream
    
    Backs up the input stream by amount steps. Lexer calls this method if it had already read some characters, but could not use them to match a (longer) token. So, they will be used again as the prefix of the next token and it is the implemetation's responsibility to do this right.
    
    Specified by:
    
    backup in interface CharStream
  - BeginToken
```
public final char BeginToken()
                      throws java.io.IOException
```
    Description copied from interface: CharStream
    
    Returns the next character that marks the beginning of the next token. All characters must remain in the buffer between two successive calls to this method to implement backup correctly.
    
    Specified by:
    
    BeginToken in interface CharStream
    
    Throws:
    
    java.io.IOException
  - GetImage
```
public final java.lang.String GetImage()
```
    Description copied from interface: CharStream
    
    Returns a string made up of characters from the marked token beginning to the current buffer position. Implementations have the choice of returning anything that they want to. For example, for efficiency, one might decide to just return null, which is a valid implementation.
    
    Specified by:
    
    GetImage in interface CharStream
  - GetSuffix
```
public char[] GetSuffix(int len)
```
    Description copied from interface: CharStream
    
    Returns an array of characters that make up the suffix of length 'len' for the currently matched token. This is used to build up the matched string for use in actions in the case of MORE. A simple and inefficient implementation of this is as follows :
    { String t = GetImage(); return t.substring(t.length() - len, t.length()).toCharArray(); }
    
    Specified by:
    
    GetSuffix in interface CharStream
  - GetNextBytes
```
public byte[] GetNextBytes(int n)
                    throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - Done
```
public void Done()
```
    Description copied from interface: CharStream
    
    The lexer calls this function to indicate that it is done with the stream and hence implementations can free any resources held by this class. Again, the body of this function can be just empty and it will not affect the lexer's operation.
    
    Specified by:
    
    Done in interface CharStream
  - currentLocation
```
public int currentLocation()
```
  - buffer
```
public byte[] buffer()
```
  - ReInit
```
public void ReInit(int offset)
```
  - ReInit
```
public void ReInit(byte[] newdata,
                   int offset)
```

Class PDFCharStream

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

staticFlag

bufpos

Constructor Detail

PDFCharStream

Method Detail

readChar

getColumn

getLine

getEndColumn

getEndLine

getBeginColumn

getBeginLine

backup

BeginToken

GetImage

GetSuffix

GetNextBytes

Done

currentLocation

buffer

ReInit

ReInit