Known Direct Subclasses
|
Known Indirect Subclasses
|
Class Overview
Subclasses of CharFilter can be chained to filter CharStream.
They can be used as Reader
with additional offset
correction. Tokenizer
s will automatically use correctOffset(int)
if a CharFilter/CharStream subclass is used.
Summary
[Expand]
Inherited Fields |
From class
java.io.Reader
|
Public Methods |
void
|
close()
|
final
int
|
correctOffset(int currentOff)
Chains the corrected offset through the input
CharFilter.
|
void
|
mark(int readAheadLimit)
|
boolean
|
markSupported()
|
int
|
read(char[] cbuf, int off, int len)
|
void
|
reset()
|
Protected Methods |
int
|
correct(int currentOff)
Subclass may want to override to correct the current offset.
|
[Expand]
Inherited Methods |
From class
org.apache.lucene.analysis.CharStream
abstract
int
|
correctOffset(int currentOff)
Called by CharFilter(s) and Tokenizer to correct token offset.
|
|
From class
java.io.Reader
abstract
void
|
close()
|
void
|
mark(int arg0)
|
boolean
|
markSupported()
|
int
|
read()
|
abstract
int
|
read(char[] arg0, int arg1, int arg2)
|
int
|
read(CharBuffer arg0)
|
int
|
read(char[] arg0)
|
boolean
|
ready()
|
void
|
reset()
|
long
|
skip(long arg0)
|
|
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
|
From interface
java.io.Closeable
|
From interface
java.lang.Readable
abstract
int
|
read(CharBuffer arg0)
|
|
Fields
Protected Constructors
Public Methods
public
final
int
correctOffset
(int currentOff)
Chains the corrected offset through the input
CharFilter.
Parameters
currentOff
| offset as seen in the output |
Returns
- corrected offset based on the input
public
void
mark
(int readAheadLimit)
public
boolean
markSupported
()
public
int
read
(char[] cbuf, int off, int len)
Protected Methods
protected
int
correct
(int currentOff)
Subclass may want to override to correct the current offset.
Parameters
currentOff
| current offset |