Package org.refcodes.io

Interface InputStreamStringBuilder

All Superinterfaces:

org.refcodes.mixin.EncodingAccessor, org.refcodes.mixin.EncodingAccessor.EncodingBuilder<InputStreamStringBuilder>, org.refcodes.mixin.EncodingAccessor.EncodingMutator, org.refcodes.mixin.EncodingAccessor.EncodingProperty, InputStreamAccessor, InputStreamAccessor.InputStreamBuilder<InputStreamStringBuilder>, InputStreamAccessor.InputStreamMutator, InputStreamAccessor.InputStreamProperty

All Known Implementing Classes:

InputStreamStringBuilderImpl

public interface InputStreamStringBuilder
extends InputStreamAccessor.InputStreamProperty, InputStreamAccessor.InputStreamBuilder<InputStreamStringBuilder>, org.refcodes.mixin.EncodingAccessor.EncodingProperty, org.refcodes.mixin.EncodingAccessor.EncodingBuilder<InputStreamStringBuilder>

The InputStreamStringBuilder constructs String instances from InputStream instances. Either use InputStreamAccessor.InputStreamMutator.setInputStream(InputStream) (withInputStream(InputStream)) followed by a Object.toString() method (not thread safe) or directly call toString(InputStream) (thread safe). You may specify an encoding to be used such as UTF-8 by either setting the encoding attribute with EncodingAccessor.EncodingMutator.setEncoding(String) (withEncoding(String)) or by passing the encoding to the conversion method as of toString(String) which overrules the encoding attribute.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.EncodingAccessor

org.refcodes.mixin.EncodingAccessor.EncodingBuilder<B extends org.refcodes.mixin.EncodingAccessor.EncodingBuilder<B>>, org.refcodes.mixin.EncodingAccessor.EncodingMutator, org.refcodes.mixin.EncodingAccessor.EncodingProperty

Nested classes/interfaces inherited from interface org.refcodes.io.InputStreamAccessor

InputStreamAccessor.InputStreamBuilder<B extends InputStreamAccessor.InputStreamBuilder<B>>, InputStreamAccessor.InputStreamMutator, InputStreamAccessor.InputStreamProperty

Method Summary

Modifier and Type	Method	Description
static InputStreamStringBuilder	build()	This is a convenience method for easily instantiating the according builder.
default String	toString(InputStream aInputStream)	The String being build by the builder upon the settings of the attributes.
String	toString(InputStream aInputStream, String aEncoding)	The String being build by the builder upon the settings of the attributes.
String	toString(String aEncoding)	The Strings being build by the builder upon the settings of the attributes.
default String[]	toStrings()	The Strings being build by the builder upon the settings of the attributes.
default String[]	toStrings(InputStream aInputStream)	The Strings being build by the builder upon the settings of the attributes.
default String[]	toStrings(InputStream aInputStream, String aEncoding)	The Strings being build by the builder upon the settings of the attributes.
default String[]	toStrings(String aEncoding)	The Strings being build by the builder upon the settings of the attributes.
default InputStreamStringBuilder	withEncoding(String aEncoding)
default InputStreamStringBuilder	withInputStream(InputStream aInputStream)	Sets the InputStream for the Input-Stream property.

Methods inherited from interface org.refcodes.mixin.EncodingAccessor

getEncoding

Methods inherited from interface org.refcodes.mixin.EncodingAccessor.EncodingMutator

setEncoding

Methods inherited from interface org.refcodes.io.InputStreamAccessor

getInputStream

Methods inherited from interface org.refcodes.io.InputStreamAccessor.InputStreamMutator

setInputStream

Method Detail

withEncoding

default InputStreamStringBuilder withEncoding(String aEncoding)

Specified by:

withEncoding in interface org.refcodes.mixin.EncodingAccessor.EncodingBuilder<InputStreamStringBuilder>

withInputStream

default InputStreamStringBuilder withInputStream(InputStream aInputStream)

Sets the InputStream for the Input-Stream property.

Specified by:

withInputStream in interface InputStreamAccessor.InputStreamBuilder<InputStreamStringBuilder>

Parameters:

aInputStream - The InputStream to be stored by the Input-Stream property.

Returns:

The builder for applying multiple build operations.

toString

default String toString(InputStream aInputStream)
                 throws IOException

The String being build by the builder upon the settings of the attributes.

Parameters:

aInputStream - The InputStream which to convert into a String.

Returns:

The according resulting String

Throws:

IOException - thrown in case accessing the InputStream caused faults.

toStrings

default String[] toStrings(InputStream aInputStream)
                    throws IOException

The Strings being build by the builder upon the settings of the attributes.

Parameters:

aInputStream - The InputStream which to convert into a String array.

Returns:

The according resulting String array

Throws:

IOException - thrown in case accessing the InputStream caused faults.

toStrings

default String[] toStrings()
                    throws IOException

The Strings being build by the builder upon the settings of the attributes.

Returns:

The according resulting String array

Throws:

IOException - thrown in case accessing the InputStream caused faults.

toString

String toString(InputStream aInputStream,
                String aEncoding)
         throws IOException

The String being build by the builder upon the settings of the attributes.

Parameters:

aInputStream - The InputStream which to convert into a String.

aEncoding - The text encoding to be used.

Returns:

The according resulting String

Throws:

IOException - thrown in case accessing the InputStream caused faults.

toStrings

default String[] toStrings(InputStream aInputStream,
                           String aEncoding)
                    throws IOException

The Strings being build by the builder upon the settings of the attributes.

Parameters:

aInputStream - The InputStream which to convert into a String array.

aEncoding - The text encoding to be used.

Returns:

The according resulting String array

Throws:

IOException - thrown in case accessing the InputStream caused faults.

toStrings

default String[] toStrings(String aEncoding)
                    throws IOException

The Strings being build by the builder upon the settings of the attributes.

Parameters:

aEncoding - The text encoding to be used.

Returns:

The according resulting String array

Throws:

IOException - thrown in case accessing the InputStream caused faults.

toString

String toString(String aEncoding)
         throws IOException

The Strings being build by the builder upon the settings of the attributes.

Parameters:

aEncoding - The text encoding to be used.

Returns:

The according resulting String array

Throws:

IOException - thrown in case accessing the InputStream caused faults.

build

static InputStreamStringBuilder build()

This is a convenience method for easily instantiating the according builder.

Returns:

an instance (using a default implementation) of this builder