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>
TheInputStreamStringBuilder
constructsString
instances fromInputStream
instances. Either useInputStreamAccessor.InputStreamMutator.setInputStream(InputStream)
(withInputStream(InputStream)
) followed by aObject.toString()
method (not thread safe) or directly calltoString(InputStream)
(thread safe). You may specify an encoding to be used such as UTF-8 by either setting the encoding attribute withEncodingAccessor.EncodingMutator.setEncoding(String)
(withEncoding(String)
) or by passing the encoding to the conversion method as oftoString(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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default java.lang.String
toString(java.io.InputStream aInputStream)
TheString
being build by the builder upon the settings of the attributes.java.lang.String
toString(java.io.InputStream aInputStream, java.lang.String aEncoding)
TheString
being build by the builder upon the settings of the attributes.java.lang.String
toString(java.lang.String aEncoding)
TheString
s being build by the builder upon the settings of the attributes.default java.lang.String[]
toStrings()
TheString
s being build by the builder upon the settings of the attributes.default java.lang.String[]
toStrings(java.io.InputStream aInputStream)
TheString
s being build by the builder upon the settings of the attributes.default java.lang.String[]
toStrings(java.io.InputStream aInputStream, java.lang.String aEncoding)
TheString
s being build by the builder upon the settings of the attributes.default java.lang.String[]
toStrings(java.lang.String aEncoding)
TheString
s being build by the builder upon the settings of the attributes.default InputStreamStringBuilder
withEncoding(java.lang.String aEncoding)
default InputStreamStringBuilder
withInputStream(java.io.InputStream aInputStream)
Sets theInputStream
for the Input-Stream property.-
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(java.lang.String aEncoding)
- Specified by:
withEncoding
in interfaceorg.refcodes.mixin.EncodingAccessor.EncodingBuilder<InputStreamStringBuilder>
-
withInputStream
default InputStreamStringBuilder withInputStream(java.io.InputStream aInputStream)
Sets theInputStream
for the Input-Stream property.- Specified by:
withInputStream
in interfaceInputStreamAccessor.InputStreamBuilder<InputStreamStringBuilder>
- Parameters:
aInputStream
- TheInputStream
to be stored by the Input-Stream property.- Returns:
- The builder for applying multiple build operations.
-
toString
default java.lang.String toString(java.io.InputStream aInputStream) throws java.io.IOException
TheString
being build by the builder upon the settings of the attributes.- Parameters:
aInputStream
- TheInputStream
which to convert into aString
.- Returns:
- The according resulting
String
- Throws:
java.io.IOException
- thrown in case accessing theInputStream
caused faults.
-
toStrings
default java.lang.String[] toStrings(java.io.InputStream aInputStream) throws java.io.IOException
TheString
s being build by the builder upon the settings of the attributes.- Parameters:
aInputStream
- TheInputStream
which to convert into aString
array.- Returns:
- The according resulting
String
array - Throws:
java.io.IOException
- thrown in case accessing theInputStream
caused faults.
-
toStrings
default java.lang.String[] toStrings() throws java.io.IOException
TheString
s being build by the builder upon the settings of the attributes.- Returns:
- The according resulting
String
array - Throws:
java.io.IOException
- thrown in case accessing theInputStream
caused faults.
-
toString
java.lang.String toString(java.io.InputStream aInputStream, java.lang.String aEncoding) throws java.io.IOException
TheString
being build by the builder upon the settings of the attributes.- Parameters:
aInputStream
- TheInputStream
which to convert into aString
.aEncoding
- The text encoding to be used.- Returns:
- The according resulting
String
- Throws:
java.io.IOException
- thrown in case accessing theInputStream
caused faults.
-
toStrings
default java.lang.String[] toStrings(java.io.InputStream aInputStream, java.lang.String aEncoding) throws java.io.IOException
TheString
s being build by the builder upon the settings of the attributes.- Parameters:
aInputStream
- TheInputStream
which to convert into aString
array.aEncoding
- The text encoding to be used.- Returns:
- The according resulting
String
array - Throws:
java.io.IOException
- thrown in case accessing theInputStream
caused faults.
-
toStrings
default java.lang.String[] toStrings(java.lang.String aEncoding) throws java.io.IOException
TheString
s 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:
java.io.IOException
- thrown in case accessing theInputStream
caused faults.
-
toString
java.lang.String toString(java.lang.String aEncoding) throws java.io.IOException
TheString
s 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:
java.io.IOException
- thrown in case accessing theInputStream
caused faults.
-
-