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:
BufferedFileChannelInputStream.Builder,CharSequenceInputStream.Builder,ChunkedOutputStream.Builder,DeferredFileOutputStream.Builder,FileWriterWithEncoding.Builder,LockableFileWriter.Builder,MemoryMappedFileInputStream.Builder,ProxyInputStream.AbstractBuilder,ProxyOutputStream.Builder,QueueInputStream.Builder,RandomAccessFileInputStream.Builder,RandomAccessFileOutputStream.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,ValidatingObjectInputStream.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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintGets the buffer size, defaults toIOUtils.DEFAULT_BUFFER_SIZE(8192).intGets the buffer size default, defaults toIOUtils.DEFAULT_BUFFER_SIZE(8192).Gets a CharSequence from the origin with a Charset.Gets the Charset, defaults toCharset.defaultCharset().Gets the Charset default, defaults toCharset.defaultCharset().getFile()Gets a File from the origin.Gets an InputStream from the origin with OpenOption[].Gets the OpenOption array.Gets an OutputStream from the origin with OpenOption[].getPath()Gets a Path from the origin.Gets a RandomAccessFile from the origin.Gets a Reader from the origin with a Charset.Gets a Writer from the origin with an OpenOption[].setBufferSize(int bufferSize) Sets the buffer size.setBufferSize(Integer bufferSize) Sets the buffer size.setBufferSizeChecker(IntUnaryOperator bufferSizeChecker) Sets the buffer size checker function.protected BsetBufferSizeDefault(int bufferSizeDefault) Sets the buffer size for subclasses to initialize.setBufferSizeMax(int bufferSizeMax) The maximum buffer size checked by the buffer size checker.setCharset(String charset) Sets the Charset.setCharset(Charset charset) Sets the Charset.protected BsetCharsetDefault(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, newRandomAccessFileOrigin, newRandomAccessFileOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, setRandomAccessFile, setRandomAccessFile, setReader, setURI, setWriterMethods inherited from class org.apache.commons.io.build.AbstractSupplier
asThisMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.commons.io.function.IOSupplier
asSupplier, get, getUnchecked
-
Constructor Details
-
AbstractStreamBuilder
public AbstractStreamBuilder()Constructs a new instance for subclasses.
-
-
Method Details
-
getBufferSize
Gets the buffer size, defaults toIOUtils.DEFAULT_BUFFER_SIZE(8192).- Returns:
- the buffer size, defaults to
IOUtils.DEFAULT_BUFFER_SIZE(8192).
-
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:
IllegalStateException- if theoriginisnull.UnsupportedOperationException- if the origin cannot be converted to a CharSequence.IOException- if an I/O error occurs.- 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().
-
getFile
Gets a File from the origin.- Returns:
- A File
- Throws:
IllegalStateException- if theoriginisnull.UnsupportedOperationException- if the origin cannot be converted to aFile.- Since:
- 2.18.0
- See Also:
-
getInputStream
Gets an InputStream from the origin with OpenOption[].- Returns:
- An input stream
- Throws:
IllegalStateException- if theoriginisnull.UnsupportedOperationException- if the origin cannot be converted to anInputStream.IOException- if an I/O error occurs.- Since:
- 2.13.0
- See Also:
-
getOpenOptions
Gets the OpenOption array.- Returns:
- the OpenOption array.
-
getOutputStream
Gets an OutputStream from the origin with OpenOption[].- Returns:
- An OutputStream
- Throws:
IllegalStateException- if theoriginisnull.UnsupportedOperationException- if the origin cannot be converted to anOutputStream.IOException- if an I/O error occurs.- Since:
- 2.13.0
- See Also:
-
getPath
Gets a Path from the origin.- Returns:
- A Path
- Throws:
IllegalStateException- if theoriginisnull.UnsupportedOperationException- if the origin cannot be converted to aPath.- Since:
- 2.13.0
- See Also:
-
getRandomAccessFile
Gets a RandomAccessFile from the origin.- Returns:
- A RandomAccessFile
- Throws:
IllegalStateException- if theoriginisnull.UnsupportedOperationException- if the origin cannot be converted to aRandomAccessFile.IOException- if an I/O error occurs.- Since:
- 2.18.0
-
getReader
Gets a Reader from the origin with a Charset.- Returns:
- A Reader
- Throws:
IllegalStateException- if theoriginisnull.UnsupportedOperationException- if the origin cannot be converted to aReader.IOException- if an I/O error occurs.- Since:
- 2.16.0
- See Also:
-
getWriter
Gets a Writer from the origin with an OpenOption[].- Returns:
- An writer.
- Throws:
IllegalStateException- if theoriginisnull.UnsupportedOperationException- if the origin cannot be converted to aWriter.IOException- if an I/O error occurs.- 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:
thisinstance.
-
setBufferSize
Sets the buffer size.Subclasses may ignore this setting.
- Parameters:
bufferSize- the buffer size, null resets to the default.- Returns:
thisinstance.
-
setBufferSizeChecker
Sets the buffer size checker function. Throws aIllegalArgumentExceptionby default.- Parameters:
bufferSizeChecker- the buffer size checker function. null resets to the default behavior.- Returns:
thisinstance.- Since:
- 2.14.0
-
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:
thisinstance.
-
setBufferSizeMax
The maximum buffer size checked by the buffer size checker. Values less or equal to 0, resets to the int max value. By default, if this value is exceeded, this methods throws anIllegalArgumentException.- Parameters:
bufferSizeMax- maximum buffer size checked by the buffer size checker.- Returns:
thisinstance.- Since:
- 2.14.0
-
setCharset
Sets the Charset.Subclasses may ignore this setting.
- Parameters:
charset- the Charset, null resets to the default.- Returns:
thisinstance.
-
setCharset
Sets the Charset.Subclasses may ignore this setting.
- Parameters:
charset- the Charset name, null resets to the default.- Returns:
thisinstance.
-
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:
thisinstance.
-
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:
thisinstance.- Since:
- 2.13.0
- See Also:
-