Package org.apache.commons.io.input
Class CharSequenceInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.apache.commons.io.input.CharSequenceInputStream
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public class CharSequenceInputStream extends java.io.InputStream
Implements anInputStream
to read bytes from String, StringBuffer, StringBuilder or CharBuffer, encoded using the specified Charset. The Charset defaults to Charset.defaultCharset().Note: Supports
mark(int)
andreset()
.To build an instance, use
CharSequenceInputStream.Builder
.- Since:
- 2.2
- See Also:
CharSequenceInputStream.Builder
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CharSequenceInputStream.Builder
Builds a newCharSequenceInputStream
.
-
Constructor Summary
Constructors Constructor Description 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()
Gets a lower bound on the number of bytes remaining in the byte stream.static CharSequenceInputStream.Builder
builder()
Constructs a newCharSequenceInputStream.Builder
.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)
-
-
-
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
@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
-
available
public int available() throws java.io.IOException
Gets a lower bound on 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
-
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
-
-