Class JsscInputStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Author:
- Andrew Pavlin, KA2DDO
-
Constructor Summary
ConstructorDescriptionJsscInputStream
(jssc.SerialPort serialPort) Wrap an InputStream around a jssc.SerialPort. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.int
read()
Reads the next byte of data from the input stream.int
read
(byte[] b) Reads some number of bytes from the input stream and stores them into the buffer arrayb
.int
read
(byte[] b, int off, int len) Reads up tolen
bytes of data from the input stream into an array of bytes.Methods inherited from class java.io.InputStream
close, mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo
-
Constructor Details
-
JsscInputStream
public JsscInputStream(jssc.SerialPort serialPort) Wrap an InputStream around a jssc.SerialPort.- Parameters:
serialPort
- SerialPort object to read from
-
-
Method Details
-
read
Reads the next byte of data from the input stream. The value byte is returned as anint
in the range0
to255
. If no byte is available because the end of the stream has been reached, the value-1
is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.- Specified by:
read
in classInputStream
- Returns:
- the next byte of data, or
-1
if the end of the stream is reached. - Throws:
IOException
- if an I/O error occurs.
-
read
Reads some number of bytes from the input stream and stores them into the buffer arrayb
. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown.If the length of
b
is zero, then no bytes are read and0
is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at the end of the file, the value-1
is returned; otherwise, at least one byte is read and stored intob
.The first byte read is stored into element
b[0]
, the next one intob[1]
, and so on. The number of bytes read is, at most, equal to the length ofb
. Let k be the number of bytes actually read; these bytes will be stored in elementsb[0]
throughb[
k-1]
, leaving elementsb[
k]
throughb[b.length-1]
unaffected.- Overrides:
read
in classInputStream
- Parameters:
b
- the buffer into which the data is read.- Returns:
- the total number of bytes read into the buffer, or
-1
if there is no more data because the end of the stream has been reached. - Throws:
IOException
- If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.NullPointerException
- ifb
isnull
.- See Also:
-
read
Reads up tolen
bytes of data from the input stream into an array of bytes. An attempt is made to read as many aslen
bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.This method blocks until input data is available, end of file is detected, or an exception is thrown.
If
len
is zero, then no bytes are read and0
is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value-1
is returned; otherwise, at least one byte is read and stored intob
.The first byte read is stored into element
b[off]
, the next one intob[off+1]
, and so on. The number of bytes read is, at most, equal tolen
. Let k be the number of bytes actually read; these bytes will be stored in elementsb[off]
throughb[off+
k-1]
, leaving elementsb[off+
k]
throughb[off+len-1]
unaffected.In every case, elements
b[0]
throughb[off]
and elementsb[off+len]
throughb[b.length-1]
are unaffected.- Overrides:
read
in classInputStream
- Parameters:
b
- the buffer into which the data is read.off
- the start offset in arrayb
at which the data is written.len
- the maximum number of bytes to read.- Returns:
- the total number of bytes read into the buffer, or
-1
if there is no more data because the end of the stream has been reached. - Throws:
IOException
- If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.NullPointerException
- Ifb
isnull
.IndexOutOfBoundsException
- Ifoff
is negative,len
is negative, orlen
is greater thanb.length - off
- See Also:
-
available
Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.Note that while some implementations of
InputStream
will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.A subclass' implementation of this method may choose to throw an
IOException
if this input stream has been closed by invoking theInputStream.close()
method.The
available
method for classInputStream
always returns0
.- Overrides:
available
in classInputStream
- Returns:
- an estimate of the number of bytes that can be read (or skipped
over) from this input stream without blocking or
0
when it reaches the end of the input stream. - Throws:
IOException
- if an I/O error occurs.
-