com.helger.commons.io.streamprovider

Class StringInputStreamProvider

java.lang.Object

com.helger.commons.io.streamprovider.StringInputStreamProvider

All Implemented Interfaces:

IHasInputStream, IHasInputStreamAndReader, IHasReader, Serializable

Direct Known Subclasses:

DOMInputStreamProvider, MicroDOMInputStreamProvider

public class StringInputStreamProvider
extends Object
implements IHasInputStreamAndReader, IHasReader, Serializable

An InputStream provider based on a String.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StringInputStreamProvider(char[] aChars, Charset aCharset)
StringInputStreamProvider(char[] aChars, int nOfs, int nLen, Charset aCharset)
StringInputStreamProvider(CharSequence aData, Charset aCharset)
StringInputStreamProvider(String sData, Charset aCharset)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
Charset	getCharset()
String	getData()
StringInputStream	getInputStream() Get the input stream to read from the object.
NonBlockingStringReader	getReader() Get the reader to read from the object.
NonBlockingStringReader	getReader(Charset aCharset) Get an Reader based on this input stream provider using the given charset.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StringInputStreamProvider

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

StringInputStreamProvider

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

StringInputStreamProvider

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

StringInputStreamProvider

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

Method Detail

getData

@Nonnull
public String getData()

getCharset

@Nonnull
public Charset getCharset()

getInputStream

@Nonnull
public final StringInputStream getInputStream()

Description copied from interface: IHasInputStream

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

Specified by:

getInputStream in interface IHasInputStream

Returns:

null if resolving failed.

getReader

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

Description copied from interface: IHasInputStreamAndReader

Get an 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

@Nonnull
public final 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:

null if resolving failed.

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