[commons-io] branch master updated: Javadoc

[ggregory]

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 6a9cb38e Javadoc
6a9cb38e is described below

commit 6a9cb38eeec6df877aba4fc6d06e83d7eb17a684
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun May 7 09:57:41 2023 -0400

    Javadoc
    
    Source clean up
---
 .../java/org/apache/commons/io/input/BOMInputStream.java   | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 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 36b4e005..252803df 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -98,6 +98,7 @@ public class BOMInputStream extends ProxyInputStream {
      * </p>
      * <pre>{@code
      * BOMInputStream s = BOMInputStream.builder()
+     *   .setPath(path)
      *   .setByteOrderMarks(ByteOrderMark.UTF_8)
      *   .setInclude(false)
      *   .get()}
@@ -113,10 +114,11 @@ public class BOMInputStream extends ProxyInputStream {
         static ByteOrderMark getDefaultBOM() {
             return DEFAULT[0];
         }
-        private boolean include;
 
         private ByteOrderMark[] byteOrderMarks = DEFAULT;
 
+        private boolean include;
+
         /**
          * Constructs a new instance.
          *
@@ -168,18 +170,18 @@ public class BOMInputStream extends ProxyInputStream {
         return new Builder();
     }
 
-    private final boolean include;
-
     /**
      * BOMs are sorted from longest to shortest.
      */
     private final List<ByteOrderMark> boms;
+
     private ByteOrderMark byteOrderMark;
-    private int[] firstBytes;
-    private int fbLength;
     private int fbIndex;
-    private int markFbIndex;
+    private int fbLength;
+    private int[] firstBytes;
+    private final boolean include;
     private boolean markedAtStart;
+    private int markFbIndex;
 
     /**
      * Constructs a new BOM InputStream that excludes a {@link 
ByteOrderMark#UTF_8} BOM.