Package org.apache.commons.io.input
Class BOMInputStream.Builder
java.lang.Object
org.apache.commons.io.build.AbstractSupplier<BOMInputStream,BOMInputStream.Builder>
org.apache.commons.io.build.AbstractOriginSupplier<BOMInputStream,BOMInputStream.Builder>
org.apache.commons.io.build.AbstractStreamBuilder<BOMInputStream,BOMInputStream.Builder>
org.apache.commons.io.input.ProxyInputStream.AbstractBuilder<BOMInputStream,BOMInputStream.Builder>
org.apache.commons.io.input.BOMInputStream.Builder
- All Implemented Interfaces:
IOSupplier<BOMInputStream>
- Enclosing class:
BOMInputStream
public static class BOMInputStream.Builder
extends ProxyInputStream.AbstractBuilder<BOMInputStream,BOMInputStream.Builder>
Builds a new
BOMInputStream.
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:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionget()Builds a newBOMInputStream.setByteOrderMarks(ByteOrderMark... byteOrderMarks) Sets the ByteOrderMarks to detect and optionally exclude.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.input.ProxyInputStream.AbstractBuilder
getAfterRead, setAfterReadMethods inherited from class org.apache.commons.io.build.AbstractStreamBuilder
getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getFile, getInputStream, getOpenOptions, getOutputStream, getPath, getRandomAccessFile, getReader, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptionsMethods 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, getUnchecked
-
Constructor Details
-
Builder
public Builder()Constructs a new builder ofBOMInputStream.
-
-
Method Details
-
get
Builds a newBOMInputStream.You must set an aspect that supports
AbstractStreamBuilder.getInputStream(), otherwise, this method throws an exception.This builder uses the following aspects: InputStream, OpenOption[], include, and ByteOrderMark[].
This builder uses the following aspects:
AbstractStreamBuilder.getInputStream()- include}
- byteOrderMarks
- Returns:
- a new instance.
- Throws:
IllegalStateException- if theoriginisnull.UnsupportedOperationException- if the origin cannot be converted to anInputStream.IOException- if an I/O error occurs converting to anInputStreamusingAbstractStreamBuilder.getInputStream().- See Also:
-
setByteOrderMarks
Sets the ByteOrderMarks to detect and optionally exclude.The default is
ByteOrderMark.UTF_8.- Parameters:
byteOrderMarks- the ByteOrderMarks to detect and optionally exclude.- Returns:
thisinstance.
-
setInclude
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:
thisinstance.
-