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
,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 ofT
.- Since:
- 2.12.0
-
-
Constructor Summary
Constructors Constructor Description AbstractStreamBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getBufferSize()
Gets the buffer size, defaults toIOUtils.DEFAULT_BUFFER_SIZE
(8192).int
getBufferSizeDefault()
Gets the buffer size default, defaults toIOUtils.DEFAULT_BUFFER_SIZE
(8192).java.lang.CharSequence
getCharSequence()
Gets a CharSequence from the origin with a Charset.java.nio.charset.Charset
getCharset()
Gets the Charset, defaults toCharset.defaultCharset()
.java.nio.charset.Charset
getCharsetDefault()
Gets the Charset default, defaults toCharset.defaultCharset()
.java.io.File
getFile()
Gets a File from the origin.java.io.InputStream
getInputStream()
Gets an InputStream from the origin with OpenOption[].java.nio.file.OpenOption[]
getOpenOptions()
Gets the OpenOption array.java.io.OutputStream
getOutputStream()
Gets an OutputStream from the origin with OpenOption[].java.nio.file.Path
getPath()
Gets a Path from the origin.java.io.RandomAccessFile
getRandomAccessFile()
Gets a RandomAccessFile from the origin.java.io.Reader
getReader()
Gets a Reader from the origin with a Charset.java.io.Writer
getWriter()
Gets a Writer from the origin with an OpenOption[].B
setBufferSize(int bufferSize)
Sets the buffer size.B
setBufferSize(java.lang.Integer bufferSize)
Sets the buffer size.B
setBufferSizeChecker(java.util.function.IntUnaryOperator bufferSizeChecker)
Sets the buffer size checker function.protected B
setBufferSizeDefault(int bufferSizeDefault)
Sets the buffer size for subclasses to initialize.B
setBufferSizeMax(int bufferSizeMax)
The maximum buffer size checked by the buffer size checker.B
setCharset(java.lang.String charset)
Sets the Charset.B
setCharset(java.nio.charset.Charset charset)
Sets the Charset.protected B
setCharsetDefault(java.nio.charset.Charset defaultCharset)
Sets the Charset default for subclasses to initialize.B
setOpenOptions(java.nio.file.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, 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, getUnchecked
-
-
-
-
Constructor Detail
-
AbstractStreamBuilder
public AbstractStreamBuilder()
-
-
Method Detail
-
getBufferSize
public int getBufferSize()
Gets the buffer size, defaults toIOUtils.DEFAULT_BUFFER_SIZE
(8192).- Returns:
- the buffer size, defaults to
IOUtils.DEFAULT_BUFFER_SIZE
(8192).
-
getBufferSizeDefault
public 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
public java.lang.CharSequence getCharSequence() throws java.io.IOException
Gets a CharSequence from the origin with a Charset.- Returns:
- An input stream
- Throws:
java.lang.IllegalStateException
- if theorigin
isnull
.java.lang.UnsupportedOperationException
- if the origin cannot be converted to a CharSequence.java.io.IOException
- if an I/O error occurs.- Since:
- 2.13.0
- See Also:
AbstractOrigin.getCharSequence(Charset)
-
getCharset
public java.nio.charset.Charset getCharset()
Gets the Charset, defaults toCharset.defaultCharset()
.- Returns:
- the Charset, defaults to
Charset.defaultCharset()
.
-
getCharsetDefault
public java.nio.charset.Charset getCharsetDefault()
Gets the Charset default, defaults toCharset.defaultCharset()
.- Returns:
- the Charset default, defaults to
Charset.defaultCharset()
.
-
getFile
public java.io.File getFile()
Gets a File from the origin.- Returns:
- A File
- Throws:
java.lang.IllegalStateException
- if theorigin
isnull
.java.lang.UnsupportedOperationException
- if the origin cannot be converted to aFile
.- Since:
- 2.18.0
- See Also:
AbstractOrigin.getPath()
-
getInputStream
public java.io.InputStream getInputStream() throws java.io.IOException
Gets an InputStream from the origin with OpenOption[].- Returns:
- An input stream
- Throws:
java.lang.IllegalStateException
- if theorigin
isnull
.java.lang.UnsupportedOperationException
- if the origin cannot be converted to anInputStream
.java.io.IOException
- if an I/O error occurs.- Since:
- 2.13.0
- See Also:
AbstractOrigin.getInputStream(OpenOption...)
,getOpenOptions()
-
getOpenOptions
public java.nio.file.OpenOption[] getOpenOptions()
Gets the OpenOption array.- Returns:
- the OpenOption array.
-
getOutputStream
public java.io.OutputStream getOutputStream() throws java.io.IOException
Gets an OutputStream from the origin with OpenOption[].- Returns:
- An OutputStream
- Throws:
java.lang.IllegalStateException
- if theorigin
isnull
.java.lang.UnsupportedOperationException
- if the origin cannot be converted to anOutputStream
.java.io.IOException
- if an I/O error occurs.- Since:
- 2.13.0
- See Also:
AbstractOrigin.getOutputStream(OpenOption...)
,getOpenOptions()
-
getPath
public java.nio.file.Path getPath()
Gets a Path from the origin.- Returns:
- A Path
- Throws:
java.lang.IllegalStateException
- if theorigin
isnull
.java.lang.UnsupportedOperationException
- if the origin cannot be converted to aPath
.- Since:
- 2.13.0
- See Also:
AbstractOrigin.getPath()
-
getRandomAccessFile
public java.io.RandomAccessFile getRandomAccessFile() throws java.io.IOException
Gets a RandomAccessFile from the origin.- Returns:
- A RandomAccessFile
- Throws:
java.lang.IllegalStateException
- if theorigin
isnull
.java.lang.UnsupportedOperationException
- if the origin cannot be converted to aRandomAccessFile
.java.io.IOException
- if an I/O error occurs.- Since:
- 2.18.0
-
getReader
public java.io.Reader getReader() throws java.io.IOException
Gets a Reader from the origin with a Charset.- Returns:
- A Reader
- Throws:
java.lang.IllegalStateException
- if theorigin
isnull
.java.lang.UnsupportedOperationException
- if the origin cannot be converted to aReader
.java.io.IOException
- if an I/O error occurs.- Since:
- 2.16.0
- See Also:
AbstractOrigin.getReader(Charset)
,getCharset()
-
getWriter
public java.io.Writer getWriter() throws java.io.IOException
Gets a Writer from the origin with an OpenOption[].- Returns:
- An writer.
- Throws:
java.lang.IllegalStateException
- if theorigin
isnull
.java.lang.UnsupportedOperationException
- if the origin cannot be converted to aWriter
.java.io.IOException
- if an I/O error occurs.- Since:
- 2.13.0
- See Also:
AbstractOrigin.getOutputStream(OpenOption...)
,getOpenOptions()
-
setBufferSize
public B setBufferSize(int bufferSize)
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
instance.
-
setBufferSize
public B setBufferSize(java.lang.Integer bufferSize)
Sets the buffer size.Subclasses may ignore this setting.
- Parameters:
bufferSize
- the buffer size, null resets to the default.- Returns:
this
instance.
-
setBufferSizeChecker
public B setBufferSizeChecker(java.util.function.IntUnaryOperator bufferSizeChecker)
Sets the buffer size checker function. Throws aIllegalArgumentException
by default.- Parameters:
bufferSizeChecker
- the buffer size checker function. null resets to the default behavior.- Returns:
this
instance.- Since:
- 2.14.0
-
setBufferSizeDefault
protected B setBufferSizeDefault(int bufferSizeDefault)
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
instance.
-
setBufferSizeMax
public B setBufferSizeMax(int bufferSizeMax)
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:
this
instance.- Since:
- 2.14.0
-
setCharset
public B setCharset(java.nio.charset.Charset charset)
Sets the Charset.Subclasses may ignore this setting.
- Parameters:
charset
- the Charset, null resets to the default.- Returns:
this
instance.
-
setCharset
public B setCharset(java.lang.String charset)
Sets the Charset.Subclasses may ignore this setting.
- Parameters:
charset
- the Charset name, null resets to the default.- Returns:
this
instance.
-
setCharsetDefault
protected B setCharsetDefault(java.nio.charset.Charset defaultCharset)
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
instance.
-
setOpenOptions
public B setOpenOptions(java.nio.file.OpenOption... openOptions)
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
instance.- Since:
- 2.13.0
- See Also:
AbstractOriginSupplier.setInputStream(InputStream)
,AbstractOriginSupplier.setOutputStream(OutputStream)
,AbstractOriginSupplier.setWriter(Writer)
-
-