Package org.apache.commons.io.input
Class UnsynchronizedBufferedReader
java.lang.Object
java.io.Reader
org.apache.commons.io.input.UnsynchronizedReader
org.apache.commons.io.input.UnsynchronizedBufferedReader
- All Implemented Interfaces:
- Closeable,- AutoCloseable,- Readable
Wraps an existing 
Reader and buffers the input without any synchronization. Expensive interaction with the underlying reader is minimized,
 since most (smaller) requests can be satisfied by accessing the buffer alone. The drawback is that some extra space is required to hold the buffer and that
 copying takes place when filling that buffer, but this is usually outweighed by the performance benefits.
 A typical application pattern for the class looks like this:
 UnsynchronizedBufferedReader buf = new UnsynchronizedBufferedReader(new FileReader("file"));
 Provenance: Apache Harmony's java.io.BufferedReader, renamed, and modified.
- Since:
- 2.17.0
- See Also:
- 
Field Summary
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs a new BufferedReader on the Readerin.UnsynchronizedBufferedReader(Reader in, int size) Constructs a new BufferedReader on the Readerin.
- 
Method SummaryModifier and TypeMethodDescriptionvoidclose()Closes this reader.voidmark(int markLimit) Sets a mark position in this reader.booleanintpeek()Returns the next character in the current reader without consuming it.intpeek(char[] buf) Populates the buffer with the nextbuf.lengthcharacters in the current reader without consuming them.intread()Reads a single character from this reader and returns it with the two higher-order bytes set to 0.intread(char[] buffer, int offset, int length) Reads at mostlengthcharacters from this reader and stores them atoffsetin the character arraybuffer.readLine()Returns the next line of text available from this reader.booleanready()Tests whether this reader is ready to be read without blocking.voidreset()Resets this reader's position to the lastmark()location.longskip(long amount) Skipsamountcharacters in this reader.Methods inherited from class org.apache.commons.io.input.UnsynchronizedReaderisClosed, setClosed
- 
Constructor Details- 
UnsynchronizedBufferedReaderConstructs a new BufferedReader on the Readerin. The buffer gets the default size (8 KB).- Parameters:
- in- the Reader that is buffered.
 
- 
UnsynchronizedBufferedReaderConstructs a new BufferedReader on the Readerin. The buffer size is specified by the parametersize.- Parameters:
- in- the Reader that is buffered.
- size- the size of the buffer to allocate.
- Throws:
- IllegalArgumentException- if- size <= 0.
 
 
- 
- 
Method Details- 
closeCloses this reader. This implementation closes the buffered source reader and releases the buffer. Nothing is done if this reader has already been closed.- Specified by:
- closein interface- AutoCloseable
- Specified by:
- closein interface- Closeable
- Overrides:
- closein class- UnsynchronizedReader
- Throws:
- IOException- if an error occurs while closing this reader.
 
- 
markSets a mark position in this reader. The parametermarkLimitindicates how many characters can be read before the mark is invalidated. Callingreset()will reposition the reader back to the marked position ifmarkLimithas not been surpassed.- Overrides:
- markin class- Reader
- Parameters:
- markLimit- the number of characters that can be read before the mark is invalidated.
- Throws:
- IllegalArgumentException- if- markLimit < 0.
- IOException- if an error occurs while setting a mark in this reader.
- See Also:
 
- 
markSupportedTests whether this reader supports themark(int)andreset()methods. This implementation returnstrue.- Overrides:
- markSupportedin class- Reader
- Returns:
- truefor- BufferedReader.
- See Also:
 
- 
peekReturns the next character in the current reader without consuming it. So the next call toread()will still return this value.- Returns:
- the next character
- Throws:
- IOException- If an I/O error occurs
 
- 
peekPopulates the buffer with the nextbuf.lengthcharacters in the current reader without consuming them. The next call toread()will still return the next value.- Parameters:
- buf- the buffer to fill for the look ahead.
- Returns:
- the buffer itself
- Throws:
- IOException- If an I/O error occurs
 
- 
readReads a single character from this reader and returns it with the two higher-order bytes set to 0. If possible, BufferedReader returns a character from the buffer. If there are no characters available in the buffer, it fills the buffer and then returns a character. It returns -1 if there are no more characters in the source reader.- Overrides:
- readin class- Reader
- Returns:
- the character read or -1 if the end of the source reader has been reached.
- Throws:
- IOException- if this reader is closed or some other I/O error occurs.
 
- 
readReads at mostlengthcharacters from this reader and stores them atoffsetin the character arraybuffer. Returns the number of characters actually read or -1 if the end of the source reader has been reached. If all the buffered characters have been used, a mark has not been set and the requested number of characters is larger than this readers buffer size, BufferedReader bypasses the buffer and simply places the results directly intobuffer.- Specified by:
- readin class- Reader
- Parameters:
- buffer- the character array to store the characters read.
- offset- the initial position in- bufferto store the bytes read from this reader.
- length- the maximum number of characters to read, must be non-negative.
- Returns:
- number of characters read or -1 if the end of the source reader has been reached.
- Throws:
- IndexOutOfBoundsException- if- offset < 0or- length < 0, or if- offset + lengthis greater than the size of- buffer.
- IOException- if this reader is closed or some other I/O error occurs.
 
- 
readLineReturns the next line of text available from this reader. A line is represented by zero or more characters followed byLF,CR,"\r\n"or the end of the reader. The string does not include the newline sequence.- Returns:
- the contents of the line or nullif no characters were read before the end of the reader has been reached.
- Throws:
- IOException- if this reader is closed or some other I/O error occurs.
 
- 
readyTests whether this reader is ready to be read without blocking.- Overrides:
- readyin class- Reader
- Returns:
- trueif this reader will not block when- readis called,- falseif unknown or blocking will occur.
- Throws:
- IOException- if this reader is closed or some other I/O error occurs.
- See Also:
 
- 
resetResets this reader's position to the lastmark()location. Invocations ofread()andskip()will occur from this new location.- Overrides:
- resetin class- Reader
- Throws:
- IOException- if this reader is closed or no mark has been set.
- See Also:
 
- 
skipSkipsamountcharacters in this reader. Subsequentread()s will not return these characters unlessreset()is used. Skipping characters may invalidate a mark ifmarkLimitis surpassed.- Overrides:
- skipin class- UnsynchronizedReader
- Parameters:
- amount- the maximum number of characters to skip.
- Returns:
- the number of characters actually skipped.
- Throws:
- IllegalArgumentException- if- amount < 0.
- IOException- if this reader is closed or some other I/O error occurs.
- See Also:
 
 
-