Skip to content

Commit 6cbfdca

Browse files
committed
Javadoc
1 parent 9bf29a7 commit 6cbfdca

1 file changed

Lines changed: 14 additions & 5 deletions

File tree

src/main/java/org/apache/commons/io/input/BOMInputStream.java

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -98,17 +98,26 @@ public class BOMInputStream extends ProxyInputStream {
9898

9999
/**
100100
* Builds a new {@link BOMInputStream} instance.
101-
* <p>
102-
* For example:
103-
* </p>
101+
* <h2>
102+
* Using NIO
103+
* </2>
104104
* <pre>{@code
105105
* BOMInputStream s = BOMInputStream.builder()
106-
* .setPath(path)
106+
* .setPath(Paths.get("MyFile.xml"))
107+
* .setByteOrderMarks(ByteOrderMark.UTF_8)
108+
* .setInclude(false)
109+
* .get()}
110+
* </pre>
111+
* <h2>
112+
* Using IO
113+
* </2>
114+
* <pre>{@code
115+
* BOMInputStream s = BOMInputStream.builder()
116+
* .setFile(new File("MyFile.xml"))
107117
* .setByteOrderMarks(ByteOrderMark.UTF_8)
108118
* .setInclude(false)
109119
* .get()}
110120
* </pre>
111-
* <p>
112121
* @since 2.12.0
113122
*/
114123
public static class Builder extends AbstractStreamBuilder<BOMInputStream, Builder> {

0 commit comments

Comments
 (0)