jhelp.util.io

Class StringInputStream

java.lang.Object

java.io.InputStream

jhelp.util.io.StringInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class StringInputStream
extends java.io.InputStream

Stream for read a String

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.ByteArrayInputStream	byteArrayInputStream Stream for read String bytes

Constructor Summary

Constructors

Constructor and Description
StringInputStream(java.lang.String string) Create a new instance of StringInputStream

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Number of available bytes Parent documentation:
void	close() Close the stream Parent documentation:
void	mark(int readlimit) Mark current reading position Parent documentation:
boolean	markSupported() Indicates if mark are supported Parent documentation:
int	read() Read one byte Parent documentation:
int	read(byte[] b) Read some bytes and fill an array.
int	read(byte[] array, int offset, int length) Read some bytes and fill a part of array Parent documentation:
void	reset() Reset the stream Parent documentation:
long	skip(long n) Skip a number of bytes Parent documentation:

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

byteArrayInputStream

private final java.io.ByteArrayInputStream byteArrayInputStream

Stream for read String bytes

Constructor Detail

StringInputStream

public StringInputStream(java.lang.String string)

Create a new instance of StringInputStream

Parameters:

string - String to read

Method Detail

available

public int available()
              throws java.io.IOException

Number of available bytes

Parent documentation:

Overrides:

available in class java.io.InputStream

Returns:

Number of available bytes

Throws:

java.io.IOException - On reading issue

See Also:

InputStream.available()

close

public void close()
           throws java.io.IOException

Close the stream

Parent documentation:

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException - On closing issue

See Also:

InputStream.close()

mark

public void mark(int readlimit)

Mark current reading position

Parent documentation:

Overrides:

mark in class java.io.InputStream

Parameters:

readlimit - Read limit

See Also:

InputStream.mark(int)

markSupported

public boolean markSupported()

Indicates if mark are supported

Parent documentation:

Overrides:

markSupported in class java.io.InputStream

Returns:

true if mark are supported

See Also:

InputStream.markSupported()

read

public int read()
         throws java.io.IOException

Read one byte

Parent documentation:

Specified by:

read in class java.io.InputStream

Returns:

Byte read or -1 if reach stream end

Throws:

java.io.IOException - On reading issue

See Also:

InputStream.read()

read

public int read(byte[] b)
         throws java.io.IOException

Read some bytes and fill an array.
Same as read(b, 0, b.length)

Parent documentation:

Overrides:

read in class java.io.InputStream

Parameters:

b - Array to fill

Returns:

Number of read bytes or -1 if reach stream end

Throws:

java.io.IOException - On reading issue

See Also:

InputStream.read(byte[])

read

public int read(byte[] array,
       int offset,
       int length)
         throws java.io.IOException

Read some bytes and fill a part of array

Parent documentation:

Overrides:

read in class java.io.InputStream

Parameters:

array - Array to fill

offset - Offset to start write in array

length - Number of byte to read

Returns:

Number of read bytes or -1 if reach stream end

Throws:

java.io.IOException - On reading issue

See Also:

InputStream.read(byte[], int, int)

reset

public void reset()
           throws java.io.IOException

Reset the stream

Parent documentation:

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException - On resting issue

See Also:

InputStream.reset()

skip

public long skip(long n)
          throws java.io.IOException

Skip a number of bytes

Parent documentation:

Overrides:

skip in class java.io.InputStream

Parameters:

n - Number of bytes to skip

Returns:

Number of skipped bytes

Throws:

java.io.IOException - On skipping issue

See Also:

InputStream.skip(long)