Package com.helger.base.io.streamprovider

Class StringInputStreamProvider

java.lang.Object

com.helger.base.io.streamprovider.StringInputStreamProvider

All Implemented Interfaces:

IHasInputStream, IHasInputStreamAndReader, IHasReader

public class StringInputStreamProvider
extends Object
implements IHasInputStreamAndReader, IHasReader

An InputStream provider based on a String.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
StringInputStreamProvider(char @NonNull [] aChars, int nOfs, int nLen, @NonNull Charset aCharset)	Constructor using a portion of a char array.
StringInputStreamProvider(char @NonNull [] aChars, @NonNull Charset aCharset)	Constructor using a char array.
StringInputStreamProvider(@NonNull CharSequence aData, @NonNull Charset aCharset)	Constructor using a CharSequence.
StringInputStreamProvider(@NonNull String sData, @NonNull Charset aCharset)	Constructor using a String.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
final @NonNull Charset	getCharset()
final @NonNull String	getData()
final @NonNull StringInputStream	getInputStream()	Get the input stream to read from the object.
final @NonNull NonBlockingStringReader	getReader()	Get the reader to read from the object.
final @NonNull NonBlockingStringReader	getReader(@NonNull Charset aCharset)	Get a Reader based on this input stream provider using the given charset.
int	hashCode()
final boolean	isReadMultiple()	Check if the InputStream from IHasInputStream.getInputStream() and IHasInputStream.getBufferedInputStream() can be acquired more than once.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.base.io.iface.IHasInputStream

getBufferedInputStream, withBufferedInputStreamDo, withInputStreamDo

Methods inherited from interface com.helger.base.io.iface.IHasInputStreamAndReader

getBufferedReader

Methods inherited from interface com.helger.base.io.iface.IHasReader

getBufferedReader

Constructor Details

StringInputStreamProvider

public StringInputStreamProvider(char @NonNull [] aChars,
 @NonNull Charset aCharset)

Constructor using a char array.

Parameters:

aChars - The char data. May not be null.

aCharset - The charset to use. May not be null.

StringInputStreamProvider

public StringInputStreamProvider(char @NonNull [] aChars,
 @Nonnegative
 int nOfs,
 @Nonnegative
 int nLen,
 @NonNull Charset aCharset)

Constructor using a portion of a char array.

Parameters:

aChars - The char data. May not be null.

nOfs - Offset into the char array. Must be ≥ 0.

nLen - Number of chars to use. Must be ≥ 0.

aCharset - The charset to use. May not be null.

StringInputStreamProvider

public StringInputStreamProvider(@NonNull CharSequence aData,
 @NonNull Charset aCharset)

Constructor using a CharSequence.

Parameters:

aData - The char sequence data. May not be null.

aCharset - The charset to use. May not be null.

StringInputStreamProvider

public StringInputStreamProvider(@NonNull String sData,
 @NonNull Charset aCharset)

Constructor using a String.

Parameters:

sData - The string data. May not be null.

aCharset - The charset to use. May not be null.

Method Details

getData

public final @NonNull String getData()

Returns:

The data string. Never null.

getCharset

public final @NonNull Charset getCharset()

Returns:

The charset used for encoding. Never null.

getInputStream

public final @NonNull StringInputStream getInputStream()

Get the input stream to read from the object. Each time this method is called, a new InputStream needs to be created.

Specified by:

getInputStream in interface IHasInputStream

Returns:

null if resolving failed.

getReader

public final @NonNull NonBlockingStringReader getReader(@NonNull Charset aCharset)

Get a Reader based on this input stream provider using the given charset.

Specified by:

getReader in interface IHasInputStreamAndReader

Parameters:

aCharset - The charset to use. May not be null.

Returns:

null if no input stream could be retrieved.

getReader

public final @NonNull NonBlockingStringReader getReader()

Description copied from interface: IHasReader

Get the reader to read from the object. Each time this method is call, a new Reader needs to be created!

Specified by:

getReader in interface IHasReader

Returns:

A new reader for the contained string data. Never null.

isReadMultiple

public final boolean isReadMultiple()

Check if the InputStream from IHasInputStream.getInputStream() and IHasInputStream.getBufferedInputStream() can be acquired more than once.

Specified by:

isReadMultiple in interface IHasInputStream

Returns:

true if the input stream can be acquired more than once, false if not.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object