This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-io.git
The following commit(s) were added to refs/heads/master by this push: new 6cbfdca9 Javadoc 6cbfdca9 is described below commit 6cbfdca9c228be416af8742d755cb910b2fabe32 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Thu May 18 17:14:03 2023 -0400 Javadoc --- .../org/apache/commons/io/input/BOMInputStream.java | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java b/src/main/java/org/apache/commons/io/input/BOMInputStream.java index 53e3d50c..0075caf7 100644 --- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java +++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java @@ -98,17 +98,26 @@ public class BOMInputStream extends ProxyInputStream { /** * Builds a new {@link BOMInputStream} instance. - * <p> - * For example: - * </p> + * <h2> + * Using NIO + * </2> * <pre>{@code * BOMInputStream s = BOMInputStream.builder() - * .setPath(path) + * .setPath(Paths.get("MyFile.xml")) + * .setByteOrderMarks(ByteOrderMark.UTF_8) + * .setInclude(false) + * .get()} + * </pre> + * <h2> + * Using IO + * </2> + * <pre>{@code + * BOMInputStream s = BOMInputStream.builder() + * .setFile(new File("MyFile.xml")) * .setByteOrderMarks(ByteOrderMark.UTF_8) * .setInclude(false) * .get()} * </pre> - * <p> * @since 2.12.0 */ public static class Builder extends AbstractStreamBuilder<BOMInputStream, Builder> {