Package org.apache.commons.io.input
Class CharSequenceInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.apache.commons.io.input.CharSequenceInputStream
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CharSequenceInputStream.Builder
Builds a newCharSequenceInputStream
instance.
-
Constructor Summary
Constructors Modifier Constructor Description private
CharSequenceInputStream(java.lang.CharSequence cs, int bufferSize, java.nio.charset.CharsetEncoder charsetEncoder)
CharSequenceInputStream(java.lang.CharSequence cs, java.lang.String charset)
Deprecated.CharSequenceInputStream(java.lang.CharSequence cs, java.lang.String charset, int bufferSize)
Deprecated.CharSequenceInputStream(java.lang.CharSequence cs, java.nio.charset.Charset charset)
Deprecated.CharSequenceInputStream(java.lang.CharSequence cs, java.nio.charset.Charset charset, int bufferSize)
Deprecated.
-
Method Summary
All Methods Static 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.static CharSequenceInputStream.Builder
builder()
Constructs a newCharSequenceInputStream.Builder
.void
close()
private void
fillBuffer()
Fills the byte output buffer from the input char buffer.(package private) java.nio.charset.CharsetEncoder
getCharsetEncoder()
Gets the CharsetEncoder.void
mark(int readlimit)
boolean
markSupported()
private static java.nio.charset.CharsetEncoder
newEncoder(java.nio.charset.Charset charset)
int
read()
int
read(byte[] b)
int
read(byte[] array, int off, int len)
void
reset()
long
skip(long n)
-
-
-
Field Detail
-
NO_MARK
private static final int NO_MARK
- See Also:
- Constant Field Values
-
bBuf
private final java.nio.ByteBuffer bBuf
-
bBufMark
private int bBufMark
-
cBuf
private final java.nio.CharBuffer cBuf
-
cBufMark
private int cBufMark
-
charsetEncoder
private final java.nio.charset.CharsetEncoder charsetEncoder
-
-
Constructor Detail
-
CharSequenceInputStream
@Deprecated public CharSequenceInputStream(java.lang.CharSequence cs, java.nio.charset.Charset charset)
Deprecated.Constructs a new instance with a buffer size ofIOUtils.DEFAULT_BUFFER_SIZE
.- Parameters:
cs
- the input character sequence.charset
- the character set name to use.- Throws:
java.lang.IllegalArgumentException
- if the buffer is not large enough to hold a complete character.
-
CharSequenceInputStream
@Deprecated public CharSequenceInputStream(java.lang.CharSequence cs, java.nio.charset.Charset charset, int bufferSize)
Deprecated.Constructs a new instance.- Parameters:
cs
- the input character sequence.charset
- the character set name to use, null maps to the default Charset.bufferSize
- the buffer size to use.- Throws:
java.lang.IllegalArgumentException
- if the buffer is not large enough to hold a complete character.
-
CharSequenceInputStream
private CharSequenceInputStream(java.lang.CharSequence cs, int bufferSize, java.nio.charset.CharsetEncoder charsetEncoder)
-
CharSequenceInputStream
@Deprecated public CharSequenceInputStream(java.lang.CharSequence cs, java.lang.String charset)
Deprecated.Constructs a new instance with a buffer size ofIOUtils.DEFAULT_BUFFER_SIZE
.- Parameters:
cs
- the input character sequence.charset
- the character set name to use.- Throws:
java.lang.IllegalArgumentException
- if the buffer is not large enough to hold a complete character.
-
CharSequenceInputStream
@Deprecated public CharSequenceInputStream(java.lang.CharSequence cs, java.lang.String charset, int bufferSize)
Deprecated.Constructs a new instance.- Parameters:
cs
- the input character sequence.charset
- the character set name to use, null maps to the default Charset.bufferSize
- the buffer size to use.- Throws:
java.lang.IllegalArgumentException
- if the buffer is not large enough to hold a complete character.
-
-
Method Detail
-
builder
public static CharSequenceInputStream.Builder builder()
Constructs a newCharSequenceInputStream.Builder
.- Returns:
- a new
CharSequenceInputStream.Builder
. - Since:
- 2.12.0
-
newEncoder
private static java.nio.charset.CharsetEncoder newEncoder(java.nio.charset.Charset charset)
-
available
public int available() throws java.io.IOException
Return an estimate of the number of bytes remaining in the byte stream.- Overrides:
available
in classjava.io.InputStream
- Returns:
- the count of bytes that can be read without blocking (or returning EOF).
- Throws:
java.io.IOException
- if an error occurs (probably not possible).
-
close
public void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Overrides:
close
in classjava.io.InputStream
- Throws:
java.io.IOException
-
fillBuffer
private void fillBuffer() throws java.nio.charset.CharacterCodingException
Fills the byte output buffer from the input char buffer.- Throws:
java.nio.charset.CharacterCodingException
- an error encoding data.
-
getCharsetEncoder
java.nio.charset.CharsetEncoder getCharsetEncoder()
Gets the CharsetEncoder.- Returns:
- the CharsetEncoder.
-
mark
public void mark(int readlimit)
- Overrides:
mark
in classjava.io.InputStream
- Parameters:
readlimit
- max read limit (ignored).
-
markSupported
public boolean markSupported()
- Overrides:
markSupported
in classjava.io.InputStream
-
read
public int read() throws java.io.IOException
- Specified by:
read
in classjava.io.InputStream
- Throws:
java.io.IOException
-
read
public int read(byte[] b) throws java.io.IOException
- Overrides:
read
in classjava.io.InputStream
- Throws:
java.io.IOException
-
read
public int read(byte[] array, int off, int len) throws java.io.IOException
- Overrides:
read
in classjava.io.InputStream
- Throws:
java.io.IOException
-
reset
public void reset() throws java.io.IOException
- Overrides:
reset
in classjava.io.InputStream
- Throws:
java.io.IOException
-
skip
public long skip(long n) throws java.io.IOException
- Overrides:
skip
in classjava.io.InputStream
- Throws:
java.io.IOException
-
-