Package org.apache.sshd.scp.server
Class InputStreamReader
java.lang.Object
java.io.Reader
org.apache.sshd.scp.server.InputStreamReader
- All Implemented Interfaces:
Closeable,AutoCloseable,Readable
A class for turning a byte stream into a character stream. Data read from the source input stream is converted into
characters by either a default or a provided character converter. The default encoding is taken from the
"file.encoding" system property.
InputStreamReader contains a buffer of bytes read from the source stream and
converts these into characters as needed. The buffer size is 8K.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int(package private) ByteBuffer(package private) CharsetDecoderprivate booleanprivate InputStream(package private) char -
Constructor Summary
ConstructorsConstructorDescriptionInputStreamReader(InputStream in, String enc) Constructs a new InputStreamReader on the InputStreamin.InputStreamReader(InputStream in, Charset charset) Constructs a new InputStreamReader on the InputStreaminand Charsetcharset.InputStreamReader(InputStream in, CharsetDecoder dec) Constructs a new InputStreamReader on the InputStreaminand CharsetDecoderdec. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Closes this reader.Returns the name of the encoding used to convert bytes into characters.private booleanisOpen()intread()Reads a single character from this reader and returns it as an integer with the two higher-order bytes set to 0.intread(char[] buf, int offset, int length) Reads at mostlengthcharacters from this reader and stores them at positionoffsetin the character arraybuf.booleanready()Indicates whether this reader is ready to be read without blocking.
-
Field Details
-
BUFFER_SIZE
private static final int BUFFER_SIZE- See Also:
-
decoder
CharsetDecoder decoder -
bytes
ByteBuffer bytes -
pending
char pending -
in
-
endOfInput
private boolean endOfInput
-
-
Constructor Details
-
InputStreamReader
Constructs a newInputStreamReaderon theInputStreamin. This constructor sets the character converter to the encoding specified in the "file.encoding" property and falls back to ISO 8859_1 (ISO-Latin-1) if the property doesn't exist.- Parameters:
in- the input stream from which to read characters.
-
InputStreamReader
Constructs a new InputStreamReader on the InputStreamin. The character converter that is used to decode bytes into characters is identified by name byenc. If the encoding cannot be found, an UnsupportedEncodingException error is thrown.- Parameters:
in- the InputStream from which to read characters.enc- identifies the character converter to use.- Throws:
NullPointerException- ifencisnull.UnsupportedEncodingException- if the encoding specified byenccannot be found.
-
InputStreamReader
Constructs a new InputStreamReader on the InputStreaminand CharsetDecoderdec.- Parameters:
in- the source InputStream from which to read characters.dec- the CharsetDecoder used by the character conversion.
-
InputStreamReader
Constructs a new InputStreamReader on the InputStreaminand Charsetcharset.- Parameters:
in- the source InputStream from which to read characters.charset- the Charset that defines the character converter
-
-
Method Details
-
close
Closes this reader. This implementation closes the source InputStream and releases all local storage.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classReader- Throws:
IOException- if an error occurs attempting to close this reader.
-
getEncoding
Returns the name of the encoding used to convert bytes into characters. The valuenullis returned if this reader has been closed.- Returns:
- the name of the character converter or
nullif this reader is closed.
-
read
Reads a single character from this reader and returns it as an integer with the two higher-order bytes set to 0. Returns -1 if the end of the reader has been reached. The byte value is either obtained from converting bytes in this reader's buffer or by first filling the buffer from the source InputStream and then reading from the buffer.- Overrides:
readin classReader- Returns:
- the character read or -1 if the end of the reader has been reached.
- Throws:
IOException- if this reader is closed or some other I/O error occurs.
-
read
Reads at mostlengthcharacters from this reader and stores them at positionoffsetin the character arraybuf. Returns the number of characters actually read or -1 if the end of the reader has been reached. The bytes are either obtained from converting bytes in this reader's buffer or by first filling the buffer from the source InputStream and then reading from the buffer.- Specified by:
readin classReader- Parameters:
buf- the array to store the characters read.offset- the initial position inbufto store the characters read from this reader.length- the maximum number of characters to read.- Returns:
- the number of characters read or -1 if the end of the reader has been reached.
- Throws:
IndexOutOfBoundsException- ifoffset < 0orlength < 0, or ifoffset + lengthis greater than the length ofbuf.IOException- if this reader is closed or some other I/O error occurs.
-
isOpen
private boolean isOpen() -
ready
Indicates whether this reader is ready to be read without blocking. If the result istrue, the nextread()will not block. If the result isfalsethen this reader may or may not block whenread()is called. This implementation returnstrueif there are bytes available in the buffer or the source stream has bytes available.- Overrides:
readyin classReader- Returns:
trueif the receiver will not block whenread()is called,falseif unknown or blocking will occur.- Throws:
IOException- if this reader is closed or some other I/O error occurs.
-