Package org.apache.commons.io.build
Class AbstractStreamBuilder<T,B extends AbstractStreamBuilder<T,B>>
java.lang.Object
org.apache.commons.io.build.AbstractSupplier<T,B>
org.apache.commons.io.build.AbstractOriginSupplier<T,B>
org.apache.commons.io.build.AbstractStreamBuilder<T,B>
- Type Parameters:
T
- the type of instances to build.B
- the type of builder subclass.
- All Implemented Interfaces:
IOSupplier<T>
- Direct Known Subclasses:
AutoCloseInputStream.Builder
,BOMInputStream.Builder
,BufferedFileChannelInputStream.Builder
,CharSequenceInputStream.Builder
,ChunkedOutputStream.Builder
,DeferredFileOutputStream.Builder
,FileWriterWithEncoding.Builder
,LockableFileWriter.Builder
,MemoryMappedFileInputStream.Builder
,MessageDigestCalculatingInputStream.Builder
,QueueInputStream.Builder
,RandomAccessFileInputStream.Builder
,ReadAheadInputStream.Builder
,ReaderInputStream.Builder
,ReversedLinesFileReader.Builder
,Tailer.Builder
,UncheckedBufferedReader.Builder
,UncheckedFilterInputStream.Builder
,UncheckedFilterOutputStream.Builder
,UncheckedFilterReader.Builder
,UncheckedFilterWriter.Builder
,UnsynchronizedBufferedInputStream.Builder
,UnsynchronizedByteArrayInputStream.Builder
,UnsynchronizedByteArrayOutputStream.Builder
,UnsynchronizedFilterInputStream.Builder
,WriterOutputStream.Builder
,XmlStreamReader.Builder
,XmlStreamWriter.Builder
public abstract class AbstractStreamBuilder<T,B extends AbstractStreamBuilder<T,B>>
extends AbstractOriginSupplier<T,B>
Abstracts building a typed instance of
T
.- Since:
- 2.12.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
The buffer size, defaults toIOUtils.DEFAULT_BUFFER_SIZE
(8192).private int
The buffer size, defaults toIOUtils.DEFAULT_BUFFER_SIZE
(8192).private Charset
The Charset, defaults toCharset.defaultCharset()
.private Charset
The Charset, defaults toCharset.defaultCharset()
.private static final OpenOption[]
private OpenOption[]
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected int
Gets the buffer size, defaults toIOUtils.DEFAULT_BUFFER_SIZE
(8192).protected int
Gets the buffer size default, defaults toIOUtils.DEFAULT_BUFFER_SIZE
(8192).protected CharSequence
Gets a CharSequence from the origin with a Charset.Gets the Charset, defaults toCharset.defaultCharset()
.protected Charset
Gets the Charset default, defaults toCharset.defaultCharset()
.protected InputStream
Gets an input stream from the origin with open options.protected OpenOption[]
protected OutputStream
Gets an OutputStream from the origin with open options.protected Path
getPath()
Gets a Path from the origin.protected Writer
Gets an writer from the origin with open options.setBufferSize
(int bufferSize) Sets the buffer size.setBufferSize
(Integer bufferSize) Sets the buffer size.protected B
setBufferSizeDefault
(int bufferSizeDefault) Sets the buffer size for subclasses to initialize.setCharset
(String charset) Sets the Charset.setCharset
(Charset charset) Sets the Charset.protected B
setCharsetDefault
(Charset defaultCharset) Sets the Charset default for subclasses to initialize.setOpenOptions
(OpenOption... openOptions) Sets the OpenOption[].Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier
checkOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newCharSequenceOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, setReader, setURI, setWriter
Methods inherited from class org.apache.commons.io.build.AbstractSupplier
asThis
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.commons.io.function.IOSupplier
asSupplier, get
-
Field Details
-
DEFAULT_OPEN_OPTIONS
-
bufferSize
private int bufferSizeThe buffer size, defaults toIOUtils.DEFAULT_BUFFER_SIZE
(8192). -
bufferSizeDefault
private int bufferSizeDefaultThe buffer size, defaults toIOUtils.DEFAULT_BUFFER_SIZE
(8192). -
charset
The Charset, defaults toCharset.defaultCharset()
. -
charsetDefault
The Charset, defaults toCharset.defaultCharset()
. -
openOptions
-
-
Constructor Details
-
AbstractStreamBuilder
public AbstractStreamBuilder()
-
-
Method Details
-
getBufferSize
protected int getBufferSize()Gets the buffer size, defaults toIOUtils.DEFAULT_BUFFER_SIZE
(8192).- Returns:
- the buffer size, defaults to
IOUtils.DEFAULT_BUFFER_SIZE
(8192).
-
getBufferSizeDefault
protected int getBufferSizeDefault()Gets the buffer size default, defaults toIOUtils.DEFAULT_BUFFER_SIZE
(8192).- Returns:
- the buffer size default, defaults to
IOUtils.DEFAULT_BUFFER_SIZE
(8192).
-
getCharSequence
Gets a CharSequence from the origin with a Charset.- Returns:
- An input stream
- Throws:
IOException
- if an I/O error occurs.UnsupportedOperationException
- if the origin cannot be converted to a CharSequence.IllegalStateException
- if theorigin
isnull
.- Since:
- 2.13.0
- See Also:
-
getCharset
Gets the Charset, defaults toCharset.defaultCharset()
.- Returns:
- the Charset, defaults to
Charset.defaultCharset()
.
-
getCharsetDefault
Gets the Charset default, defaults toCharset.defaultCharset()
.- Returns:
- the Charset default, defaults to
Charset.defaultCharset()
.
-
getInputStream
Gets an input stream from the origin with open options.- Returns:
- An input stream
- Throws:
IOException
- if an I/O error occurs.UnsupportedOperationException
- if the origin cannot be converted to an InputStream.IllegalStateException
- if theorigin
isnull
.- Since:
- 2.13.0
- See Also:
-
getOpenOptions
-
getOutputStream
Gets an OutputStream from the origin with open options.- Returns:
- An OutputStream
- Throws:
IOException
- if an I/O error occurs.UnsupportedOperationException
- if the origin cannot be converted to an OututStream.IllegalStateException
- if theorigin
isnull
.- Since:
- 2.13.0
- See Also:
-
getPath
Gets a Path from the origin.- Returns:
- A Path
- Throws:
UnsupportedOperationException
- if the origin cannot be converted to a Path.IllegalStateException
- if theorigin
isnull
.- Since:
- 2.13.0
- See Also:
-
getWriter
Gets an writer from the origin with open options.- Returns:
- An writer.
- Throws:
IOException
- if an I/O error occurs.UnsupportedOperationException
- if the origin cannot be converted to a Writer.IllegalStateException
- if theorigin
isnull
.- Since:
- 2.13.0
- See Also:
-
setBufferSize
Sets the buffer size. Invalid input (bufferSize <= 0) resets the value to its default.Subclasses may ignore this setting.
- Parameters:
bufferSize
- the buffer size.- Returns:
- this.
-
setBufferSize
Sets the buffer size.Subclasses may ignore this setting.
- Parameters:
bufferSize
- the buffer size, null resets to the default.- Returns:
- this.
-
setBufferSizeDefault
Sets the buffer size for subclasses to initialize.Subclasses may ignore this setting.
- Parameters:
bufferSizeDefault
- the buffer size, null resets to the default.- Returns:
- this.
-
setCharset
Sets the Charset.Subclasses may ignore this setting.
- Parameters:
charset
- the Charset, null resets to the default.- Returns:
- this.
-
setCharset
Sets the Charset.Subclasses may ignore this setting.
- Parameters:
charset
- the Charset name, null resets to the default.- Returns:
- this.
-
setCharsetDefault
Sets the Charset default for subclasses to initialize.Subclasses may ignore this setting.
- Parameters:
defaultCharset
- the Charset name, null resets to the default.- Returns:
- this.
-
setOpenOptions
Sets the OpenOption[].Normally used with InputStream, OutputStream, and Writer.
Subclasses may ignore this setting.
- Parameters:
openOptions
- the OpenOption[] name, null resets to the default.- Returns:
- this.
- Since:
- 2.13.0
- See Also:
-