CharReader (Lucene 3.6.2 API)

java.lang.Object
- java.io.Reader
- - org.apache.lucene.analysis.CharStream
  - - org.apache.lucene.analysis.CharReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable
```
public final class CharReader
extends CharStream
```
CharReader is a Reader wrapper. It reads chars from Reader and outputs CharStream, defining an identify function correctOffset(int) method that simply returns the provided offset.

Field Summary
- Fields inherited from class java.io.Reader
  lock

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`
`int`	`correctOffset(int currentOff)`	Called by CharFilter(s) and Tokenizer to correct token offset.
`static CharStream`	`get(Reader input)`
`void`	`mark(int readAheadLimit)`
`boolean`	`markSupported()`
`int`	`read(char[] cbuf, int off, int len)`
`void`	`reset()`

Methods inherited from class java.io.Reader
nullReader, read, read, read, ready, skip, transferTo

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

- Method Detail
  - get
```
public static CharStream get(Reader input)
```
  - correctOffset
```
public int correctOffset(int currentOff)
```
    Description copied from class: CharStream
    
    Called by CharFilter(s) and Tokenizer to correct token offset.
    
    Specified by:
    
    correctOffset in class CharStream
    
    Parameters:
    
    currentOff - offset as seen in the output
    
    Returns:
    
    corrected offset based on the input
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in class Reader
    
    Throws:
    
    IOException
  - read
```
public int read(char[] cbuf,
                int off,
                int len)
         throws IOException
```
    Specified by:
    
    read in class Reader
    
    Throws:
    
    IOException
  - markSupported
```
public boolean markSupported()
```
    Overrides:
    
    markSupported in class Reader
  - mark
```
public void mark(int readAheadLimit)
          throws IOException
```
    Overrides:
    
    mark in class Reader
    
    Throws:
    
    IOException
  - reset
```
public void reset()
           throws IOException
```
    Overrides:
    
    reset in class Reader
    
    Throws:
    
    IOException