Class CharArrayReader
java.lang.Object
java.io.Reader
com.opensymphony.module.sitemesh.util.CharArrayReader
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Readable
This class implements a character buffer that can be used as a
character-input stream.
Modified from the JDK source in that it gets rid of the
ensureOpen() method, so we get unexpected behaviour if the
reader is closed.
The second modification is that since this class is used internally by FastPageParser in a single thread, we don't need any locking or synchronization. Using this class instead of the standard CharArrayReader improves FastPageParser performance by 15-20%.
- Author:
- Hani Suleiman
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected char[]
The character buffer.protected int
The index of the end of this buffer.protected int
The position of mark in buffer.protected int
The current buffer position. -
Constructor Summary
ConstructorsConstructorDescriptionCharArrayReader
(char[] buf) Create an CharArrayReader from the specified array of chars.CharArrayReader
(char[] buf, int offset, int length) Create an CharArrayReader from the specified array of chars. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Close the stream.void
mark
(int readAheadLimit) Mark the present position in the stream.boolean
Tell whether this stream supports the mark() operation, which it does.int
read()
Read a single character.int
read
(char[] b, int off, int len) Read characters into a portion of an array.boolean
ready()
Tell whether this stream is ready to be read.void
reset()
Reset the stream to the most recent mark, or to the beginning if it has never been marked.long
skip
(long n) Skip characters.Methods inherited from class java.io.Reader
nullReader, read, read, transferTo
-
Field Details
-
buf
protected char[] bufThe character buffer. -
pos
protected int posThe current buffer position. -
markedPos
protected int markedPosThe position of mark in buffer. -
count
protected int countThe index of the end of this buffer. There is not valid data at or beyond this index.
-
-
Constructor Details
-
CharArrayReader
public CharArrayReader(char[] buf) Create an CharArrayReader from the specified array of chars.- Parameters:
buf
- Input buffer (not copied)
-
CharArrayReader
public CharArrayReader(char[] buf, int offset, int length) Create an CharArrayReader from the specified array of chars.- Parameters:
buf
- Input buffer (not copied)offset
- Offset of the first char to readlength
- Number of chars to read
-
-
Method Details
-
read
Read a single character.- Overrides:
read
in classReader
- Throws:
IOException
- If an I/O error occurs
-
read
Read characters into a portion of an array.- Specified by:
read
in classReader
- Parameters:
b
- Destination bufferoff
- Offset at which to start storing characterslen
- Maximum number of characters to read- Returns:
- The actual number of characters read, or -1 if the end of the stream has been reached
- Throws:
IOException
- If an I/O error occurs
-
skip
Skip characters.- Overrides:
skip
in classReader
- Parameters:
n
- The number of characters to skip- Returns:
- The number of characters actually skipped
- Throws:
IOException
- If an I/O error occurs
-
ready
Tell whether this stream is ready to be read. Character-array readers are always ready to be read.- Overrides:
ready
in classReader
- Throws:
IOException
- If an I/O error occurs
-
markSupported
public boolean markSupported()Tell whether this stream supports the mark() operation, which it does.- Overrides:
markSupported
in classReader
-
mark
Mark the present position in the stream. Subsequent calls to reset() will reposition the stream to this point.- Overrides:
mark
in classReader
- Parameters:
readAheadLimit
- Limit on the number of characters that may be read while still preserving the mark. Because the stream's input comes from a character array, there is no actual limit; hence this argument is ignored.- Throws:
IOException
- If an I/O error occurs
-
reset
Reset the stream to the most recent mark, or to the beginning if it has never been marked.- Overrides:
reset
in classReader
- Throws:
IOException
- If an I/O error occurs
-
close
public void close()Close the stream.
-