Package org.apache.commons.io.input
Class BOMInputStream.Builder
- 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<BOMInputStream,BOMInputStream.Builder>
-
- org.apache.commons.io.input.BOMInputStream.Builder
-
- All Implemented Interfaces:
IOSupplier<BOMInputStream>
- Enclosing class:
- BOMInputStream
public static class BOMInputStream.Builder extends AbstractStreamBuilder<BOMInputStream,BOMInputStream.Builder>
Builds a newBOMInputStream
.Using NIO
BOMInputStream s = BOMInputStream.builder() .setPath(Paths.get("MyFile.xml")) .setByteOrderMarks(ByteOrderMark.UTF_8) .setInclude(false) .get();
Using IO
BOMInputStream s = BOMInputStream.builder() .setFile(new File("MyFile.xml")) .setByteOrderMarks(ByteOrderMark.UTF_8) .setInclude(false) .get();
- Since:
- 2.12.0
- See Also:
get()
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BOMInputStream
get()
Builds a newBOMInputStream
.BOMInputStream.Builder
setByteOrderMarks(ByteOrderMark... byteOrderMarks)
Sets the ByteOrderMarks to detect and optionally exclude.BOMInputStream.Builder
setInclude(boolean include)
Sets whether to include the UTF-8 BOM (true) or to exclude it (false).-
Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder
getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getInputStream, getOpenOptions, getOutputStream, getPath, getReader, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptions
-
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
-
-
-
-
Constructor Detail
-
Builder
public Builder()
-
-
Method Detail
-
get
public BOMInputStream get() throws java.io.IOException
Builds a newBOMInputStream
.You must set input that supports
AbstractStreamBuilder.getInputStream()
, otherwise, this method throws an exception.This builder use the following aspects: InputStream, OpenOption[], include, and ByteOrderMark[].
This builder use the following aspects:
AbstractStreamBuilder.getInputStream()
- include}
- byteOrderMarks
- Returns:
- a new instance.
- 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.- See Also:
AbstractStreamBuilder.getInputStream()
-
setByteOrderMarks
public BOMInputStream.Builder setByteOrderMarks(ByteOrderMark... byteOrderMarks)
Sets the ByteOrderMarks to detect and optionally exclude.The default is
ByteOrderMark.UTF_8
.- Parameters:
byteOrderMarks
- the ByteOrderMarks to detect and optionally exclude.- Returns:
- this
-
setInclude
public BOMInputStream.Builder setInclude(boolean include)
Sets whether to include the UTF-8 BOM (true) or to exclude it (false).The default is false.
- Parameters:
include
- true to include the UTF-8 BOM or false to exclude it. return this;- Returns:
- this
-
-