Package org.apache.commons.io.input
Class CharSequenceInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.apache.commons.io.input.CharSequenceInputStream
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public class CharSequenceInputStream extends InputStream
InputStream
implementation that can read from String, StringBuffer, StringBuilder or CharBuffer.- Since:
- 2.2
-
-
Constructor Summary
Constructors Constructor Description CharSequenceInputStream(CharSequence cs, String charset)
Constructor, callsCharSequenceInputStream(CharSequence, String, int)
with a buffer size of 2048.CharSequenceInputStream(CharSequence cs, String charset, int bufferSize)
Constructor, callsCharSequenceInputStream(CharSequence, Charset, int)
.CharSequenceInputStream(CharSequence cs, Charset charset)
Constructor, callsCharSequenceInputStream(CharSequence, Charset, int)
with a buffer size of 2048.CharSequenceInputStream(CharSequence cs, Charset charset, int bufferSize)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
available()
Return an estimate of the number of bytes remaining in the byte stream.void
close()
void
mark(int readlimit)
boolean
markSupported()
int
read()
int
read(byte[] b)
int
read(byte[] array, int off, int len)
void
reset()
long
skip(long n)
-
Methods inherited from class java.io.InputStream
nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo
-
-
-
-
Constructor Detail
-
CharSequenceInputStream
public CharSequenceInputStream(CharSequence cs, Charset charset, int bufferSize)
Constructor.- Parameters:
cs
- the input character sequencecharset
- the character set name to usebufferSize
- the buffer size to use.- Throws:
IllegalArgumentException
- if the buffer is not large enough to hold a complete character
-
CharSequenceInputStream
public CharSequenceInputStream(CharSequence cs, String charset, int bufferSize)
Constructor, callsCharSequenceInputStream(CharSequence, Charset, int)
.- Parameters:
cs
- the input character sequencecharset
- the character set name to usebufferSize
- the buffer size to use.- Throws:
IllegalArgumentException
- if the buffer is not large enough to hold a complete character
-
CharSequenceInputStream
public CharSequenceInputStream(CharSequence cs, Charset charset)
Constructor, callsCharSequenceInputStream(CharSequence, Charset, int)
with a buffer size of 2048.- Parameters:
cs
- the input character sequencecharset
- the character set name to use- Throws:
IllegalArgumentException
- if the buffer is not large enough to hold a complete character
-
CharSequenceInputStream
public CharSequenceInputStream(CharSequence cs, String charset)
Constructor, callsCharSequenceInputStream(CharSequence, String, int)
with a buffer size of 2048.- Parameters:
cs
- the input character sequencecharset
- the character set name to use- Throws:
IllegalArgumentException
- if the buffer is not large enough to hold a complete character
-
-
Method Detail
-
read
public int read(byte[] array, int off, int len) throws IOException
- Overrides:
read
in classInputStream
- Throws:
IOException
-
read
public int read() throws IOException
- Specified by:
read
in classInputStream
- Throws:
IOException
-
read
public int read(byte[] b) throws IOException
- Overrides:
read
in classInputStream
- Throws:
IOException
-
skip
public long skip(long n) throws IOException
- Overrides:
skip
in classInputStream
- Throws:
IOException
-
available
public int available() throws IOException
Return an estimate of the number of bytes remaining in the byte stream.- Overrides:
available
in classInputStream
- Returns:
- the count of bytes that can be read without blocking (or returning EOF).
- Throws:
IOException
- if an error occurs (probably not possible)
-
close
public void close() throws IOException
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classInputStream
- Throws:
IOException
-
mark
public void mark(int readlimit)
- Overrides:
mark
in classInputStream
- Parameters:
readlimit
- max read limit (ignored)
-
reset
public void reset() throws IOException
- Overrides:
reset
in classInputStream
- Throws:
IOException
-
markSupported
public boolean markSupported()
- Overrides:
markSupported
in classInputStream
-
-