Class LineDelimiterFilterInputStream
- All Implemented Interfaces:
Closeable,AutoCloseable
'\n'.
A line is a sequence of bytes ending with a carriage return
character ('\r'), a newline character
('\n'), or a carriage return character followed
immediately by a linefeed character. In all three cases, the line
terminating character(s) are returned as a single newline character.
- Since:
- jcms-5.7.4
-
Field Summary
Fields inherited from class java.io.FilterInputStream
in -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a newline number input stream that reads its input from the specified input stream. -
Method Summary
Modifier and TypeMethodDescriptionintReturns the number of bytes that can be read from this input stream without blocking.voidmark(int readlimit) Marks the current position in this input stream.intread()Reads the next byte of data from this input stream.intread(byte[] b, int off, int len) Reads up tolenbytes of data from this input stream into an array of bytes.voidreset()Repositions this stream to the position at the time themarkmethod was last called on this input stream.longskip(long n) Skips over and discardsnbytes of data from this input stream.Methods inherited from class java.io.FilterInputStream
close, markSupported, readMethods inherited from class java.io.InputStream
nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo
-
Constructor Details
-
LineDelimiterFilterInputStream
Constructs a newline number input stream that reads its input from the specified input stream.- Parameters:
in- the underlying input stream.
-
-
Method Details
-
read
Reads the next byte of data from this input stream. The value byte is returned as anintin the range0to255. If no byte is available because the end of the stream has been reached, the value-1is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.The
readmethod ofLineDelimiterFilterInputStreamcalls thereadmethod of the underlying input stream. It checks for carriage returns and newline characters in the input, a carriage-return character or a carriage return followed by a newline character are both converted into a single newline character.- Overrides:
readin classFilterInputStream- Returns:
- the next byte of data, or
-1if the end of this stream is reached. - Throws:
IOException- if an I/O error occurs.
-
read
Reads up tolenbytes of data from this input stream into an array of bytes. This method blocks until some input is available.The
readmethod ofLineDelimiterFilterInputStreamrepeatedly calls thereadmethod of zero arguments to fill in the byte array.- Overrides:
readin classFilterInputStream- Parameters:
b- the buffer into which the data is read.off- the start offset of the data.len- the maximum number of bytes read.- Returns:
- the total number of bytes read into the buffer, or
-1if there is no more data because the end of this stream has been reached. - Throws:
IOException- if an I/O error occurs.- See Also:
-
skip
Skips over and discardsnbytes of data from this input stream. Theskipmethod may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly0. The actual number of bytes skipped is returned. Ifnis negative, no bytes are skipped.The
skipmethod ofLineDelimiterFilterInputStreamcreates a byte array and then repeatedly reads into it untilnbytes have been read or the end of the stream has been reached.- Overrides:
skipin classFilterInputStream- Parameters:
n- the number of bytes to be skipped.- Returns:
- the actual number of bytes skipped.
- Throws:
IOException- if an I/O error occurs.
-
available
Returns the number of bytes that can be read from this input stream without blocking.Note that if the underlying input stream is able to supply k input characters without blocking, the
LineDelimiterFilterInputStreamcan guarantee only to provide k/2 characters without blocking, because the k characters from the underlying input stream might consist of k/2 pairs of'\r'and'\n', which are converted to just k/2'\n'characters.- Overrides:
availablein classFilterInputStream- Returns:
- the number of bytes that can be read from this input stream without blocking.
- Throws:
IOException- if an I/O error occurs.
-
mark
public void mark(int readlimit) Marks the current position in this input stream. A subsequent call to theresetmethod repositions this stream at the last marked position so that subsequent reads re-read the same bytes.The
markmethod ofLineDelimiterFilterInputStreamremembers the current line in a private variable, and then calls themarkmethod of the underlying input stream.- Overrides:
markin classFilterInputStream- Parameters:
readlimit- the maximum limit of bytes that can be read before the mark position becomes invalid.- See Also:
-
reset
Repositions this stream to the position at the time themarkmethod was last called on this input stream.The
resetmethod ofLineDelimiterFilterInputStreamresets the current line to be the line at the time themarkmethod was called, and then calls theresetmethod of the underlying input stream.Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parser, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails, which, if it happens within readlimit bytes, allows the outer code to reset the stream and try another parser.
- Overrides:
resetin classFilterInputStream- Throws:
IOException- if an I/O error occurs.- See Also:
-