AbstractScanner (Apache Batik Javadoc)

java.lang.Object
- org.apache.batik.parser.AbstractScanner

Direct Known Subclasses:

XPathSubsetContentSelector.Scanner
```
public abstract class AbstractScanner
extends java.lang.Object
```
An abstract scanner class to be extended.

Field Summary

Fields
Modifier and Type	Field	Description
`protected int`	`blankCharacters`	The characters to skip to create the string which represents the current token.
`protected char[]`	`buffer`	The recording buffer.
`protected int`	`current`	The current char.
`protected int`	`end`	The end offset of the last lexical unit.
`protected int`	`position`	The current position in the buffer.
`protected int`	`previousType`	The previous lexical unit type that was scanned.
`protected NormalizingReader`	`reader`	The reader.
`protected int`	`start`	The start offset of the last lexical unit.
`protected int`	`type`	The type of the current lexical unit.

Constructor Summary

Constructors
Constructor	Description
`AbstractScanner(java.io.InputStream is, java.lang.String enc)`	Creates a new AbstractScanner object.
`AbstractScanner(java.io.Reader r)`	Creates a new AbstractScanner object.
`AbstractScanner(java.lang.String s)`	Creates a new AbstractScanner object.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clearBuffer()`	Clears the buffer.
`protected abstract int`	`endGap()`	Returns the end gap of the current lexical unit.
`char[]`	`getBuffer()`	Returns the buffer used to store the chars.
`int`	`getColumn()`	Returns the current column.
`int`	`getEnd()`	Returns the end offset of the last lexical unit.
`int`	`getLine()`	Returns the current line.
`int`	`getStart()`	Returns the start offset of the last lexical unit.
`java.lang.String`	`getStringValue()`	Returns the string representation of the current lexical unit.
`int`	`getType()`	The current lexical unit type like defined in LexicalUnits.
`protected static boolean`	`isEqualIgnoreCase(int i, char c)`	Compares the given int with the given character, ignoring case.
`int`	`next()`	Returns the next token.
`protected int`	`nextChar()`	Sets the value of the current char to the next character or -1 if the end of stream has been reached.
`protected abstract void`	`nextToken()`	Returns the next token.

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

- Field Detail
  - reader
```
protected NormalizingReader reader
```
    The reader.
  - current
```
protected int current
```
    The current char.
  - buffer
```
protected char[] buffer
```
    The recording buffer.
  - position
```
protected int position
```
    The current position in the buffer.
  - type
```
protected int type
```
    The type of the current lexical unit.
  - previousType
```
protected int previousType
```
    The previous lexical unit type that was scanned.
  - start
```
protected int start
```
    The start offset of the last lexical unit.
  - end
```
protected int end
```
    The end offset of the last lexical unit.
  - blankCharacters
```
protected int blankCharacters
```
    The characters to skip to create the string which represents the current token.
- Constructor Detail
  - AbstractScanner
```
public AbstractScanner(java.io.Reader r)
                throws ParseException
```
    Creates a new AbstractScanner object.
    
    Parameters:
    
    r - The reader to scan.
    
    Throws:
    
    ParseException
  - AbstractScanner
```
public AbstractScanner(java.io.InputStream is,
                       java.lang.String enc)
                throws ParseException
```
    Creates a new AbstractScanner object.
    
    Parameters:
    
    is - The input stream to scan.
    
    enc - The encoding to use to decode the input stream, or null.
    
    Throws:
    
    ParseException
  - AbstractScanner
```
public AbstractScanner(java.lang.String s)
                throws ParseException
```
    Creates a new AbstractScanner object.
    
    Parameters:
    
    s - The string to scan.
    
    Throws:
    
    ParseException
- Method Detail
  - getLine
```
public int getLine()
```
    Returns the current line.
  - getColumn
```
public int getColumn()
```
    Returns the current column.
  - getBuffer
```
public char[] getBuffer()
```
    Returns the buffer used to store the chars.
  - getStart
```
public int getStart()
```
    Returns the start offset of the last lexical unit.
  - getEnd
```
public int getEnd()
```
    Returns the end offset of the last lexical unit.
  - clearBuffer
```
public void clearBuffer()
```
    Clears the buffer.
  - getType
```
public int getType()
```
    The current lexical unit type like defined in LexicalUnits.
  - getStringValue
```
public java.lang.String getStringValue()
```
    Returns the string representation of the current lexical unit.
  - next
```
public int next()
         throws ParseException
```
    Returns the next token.
    
    Throws:
    
    ParseException
  - endGap
```
protected abstract int endGap()
```
    Returns the end gap of the current lexical unit.
  - nextToken
```
protected abstract void nextToken()
                           throws ParseException
```
    Returns the next token.
    
    Throws:
    
    ParseException
  - isEqualIgnoreCase
```
protected static boolean isEqualIgnoreCase(int i,
                                           char c)
```
    Compares the given int with the given character, ignoring case.
  - nextChar
```
protected int nextChar()
                throws java.io.IOException
```
    Sets the value of the current char to the next character or -1 if the end of stream has been reached.
    
    Throws:
    
    java.io.IOException

Class AbstractScanner

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

reader

current

buffer

position

type

previousType

start

end

blankCharacters

Constructor Detail

AbstractScanner

AbstractScanner

AbstractScanner

Method Detail

getLine

getColumn

getBuffer

getStart

getEnd

clearBuffer

getType

getStringValue

next

endGap

nextToken

isEqualIgnoreCase

nextChar