Internal refactoring

Author: garydgregory

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

@@ -216,7 +216,7 @@ public Builder() {
          */
         @Override
         public Tailer get() {
-            final Tailer tailer = new Tailer(tailable, getCharset(), tailerListener, delayDuration, tailFromEnd, reOpen, getBufferSize(), ignoreTouch);
+            final Tailer tailer = new Tailer(this);
             if (startThread) {
                 executorService.submit(tailer);
             }
@@ -514,7 +514,7 @@ public static Builder builder() {
      *
      * @param file the file to follow.
      * @param charset the character set to use for reading the file.
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @param delayMillis the delay between checks of the file for new content in milliseconds.
      * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file.
      * @param reOpen whether to close/reopen the file between chunks.
@@ -523,12 +523,12 @@ public static Builder builder() {
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public static Tailer create(final File file, final Charset charset, final TailerListener listener, final long delayMillis, final boolean end,
-        final boolean reOpen, final int bufferSize) {
+    public static Tailer create(final File file, final Charset charset, final TailerListener tailerListener, final long delayMillis, final boolean end,
+            final boolean reOpen, final int bufferSize) {
         //@formatter:off
         return builder()
                 .setFile(file)
-                .setTailerListener(listener)
+                .setTailerListener(tailerListener)
                 .setCharset(charset)
                 .setDelayDuration(Duration.ofMillis(delayMillis))
                 .setTailFromEnd(end)
@@ -542,16 +542,16 @@ public static Tailer create(final File file, final Charset charset, final Tailer
      * Creates and starts a Tailer for the given file, starting at the beginning of the file with the default delay of 1.0s
      *
      * @param file the file to follow.
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @return The new tailer.
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public static Tailer create(final File file, final TailerListener listener) {
+    public static Tailer create(final File file, final TailerListener tailerListener) {
         //@formatter:off
         return builder()
                 .setFile(file)
-                .setTailerListener(listener)
+                .setTailerListener(tailerListener)
                 .get();
         //@formatter:on
     }
@@ -560,17 +560,17 @@ public static Tailer create(final File file, final TailerListener listener) {
      * Creates and starts a Tailer for the given file, starting at the beginning of the file
      *
      * @param file the file to follow.
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @param delayMillis the delay between checks of the file for new content in milliseconds.
      * @return The new tailer.
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public static Tailer create(final File file, final TailerListener listener, final long delayMillis) {
+    public static Tailer create(final File file, final TailerListener tailerListener, final long delayMillis) {
         //@formatter:off
         return builder()
                 .setFile(file)
-                .setTailerListener(listener)
+                .setTailerListener(tailerListener)
                 .setDelayDuration(Duration.ofMillis(delayMillis))
                 .get();
         //@formatter:on
@@ -580,18 +580,18 @@ public static Tailer create(final File file, final TailerListener listener, fina
      * Creates and starts a Tailer for the given file with default buffer size.
      *
      * @param file the file to follow.
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @param delayMillis the delay between checks of the file for new content in milliseconds.
      * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file.
      * @return The new tailer.
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public static Tailer create(final File file, final TailerListener listener, final long delayMillis, final boolean end) {
+    public static Tailer create(final File file, final TailerListener tailerListener, final long delayMillis, final boolean end) {
         //@formatter:off
         return builder()
                 .setFile(file)
-                .setTailerListener(listener)
+                .setTailerListener(tailerListener)
                 .setDelayDuration(Duration.ofMillis(delayMillis))
                 .setTailFromEnd(end)
                 .get();
@@ -602,19 +602,19 @@ public static Tailer create(final File file, final TailerListener listener, fina
      * Creates and starts a Tailer for the given file with default buffer size.
      *
      * @param file the file to follow.
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @param delayMillis the delay between checks of the file for new content in milliseconds.
      * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file.
      * @param reOpen whether to close/reopen the file between chunks.
      * @return The new tailer.
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public static Tailer create(final File file, final TailerListener listener, final long delayMillis, final boolean end, final boolean reOpen) {
+    public static Tailer create(final File file, final TailerListener tailerListener, final long delayMillis, final boolean end, final boolean reOpen) {
         //@formatter:off
         return builder()
                 .setFile(file)
-                .setTailerListener(listener)
+                .setTailerListener(tailerListener)
                 .setDelayDuration(Duration.ofMillis(delayMillis))
                 .setTailFromEnd(end)
                 .setReOpen(reOpen)
@@ -626,7 +626,7 @@ public static Tailer create(final File file, final TailerListener listener, fina
      * Creates and starts a Tailer for the given file.
      *
      * @param file the file to follow.
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @param delayMillis the delay between checks of the file for new content in milliseconds.
      * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file.
      * @param reOpen whether to close/reopen the file between chunks.
@@ -635,12 +635,12 @@ public static Tailer create(final File file, final TailerListener listener, fina
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public static Tailer create(final File file, final TailerListener listener, final long delayMillis, final boolean end, final boolean reOpen,
+    public static Tailer create(final File file, final TailerListener tailerListener, final long delayMillis, final boolean end, final boolean reOpen,
         final int bufferSize) {
         //@formatter:off
         return builder()
                 .setFile(file)
-                .setTailerListener(listener)
+                .setTailerListener(tailerListener)
                 .setDelayDuration(Duration.ofMillis(delayMillis))
                 .setTailFromEnd(end)
                 .setReOpen(reOpen)
@@ -653,19 +653,19 @@ public static Tailer create(final File file, final TailerListener listener, fina
      * Creates and starts a Tailer for the given file.
      *
      * @param file the file to follow.
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @param delayMillis the delay between checks of the file for new content in milliseconds.
      * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file.
      * @param bufferSize buffer size.
      * @return The new tailer.
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public static Tailer create(final File file, final TailerListener listener, final long delayMillis, final boolean end, final int bufferSize) {
+    public static Tailer create(final File file, final TailerListener tailerListener, final long delayMillis, final boolean end, final int bufferSize) {
         //@formatter:off
         return builder()
                 .setFile(file)
-                .setTailerListener(listener)
+                .setTailerListener(tailerListener)
                 .setDelayDuration(Duration.ofMillis(delayMillis))
                 .setTailFromEnd(end)
                 .setBufferSize(bufferSize)
@@ -696,7 +696,7 @@ public static Tailer create(final File file, final TailerListener listener, fina
     /**
      * Whether to tail from the end or start of file
      */
-    private final boolean tailAtEnd;
+    private final boolean tailFromEnd;
 
     /**
      * The listener to notify of events when tailing.
@@ -723,131 +723,148 @@ public static Tailer create(final File file, final TailerListener listener, fina
      *
      * @param file the file to follow.
      * @param charset the Charset to be used for reading the file
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @param delayMillis the delay between checks of the file for new content in milliseconds.
      * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file.
      * @param reOpen if true, close and reopen the file between reading chunks
      * @param bufSize Buffer size
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public Tailer(final File file, final Charset charset, final TailerListener listener, final long delayMillis, final boolean end, final boolean reOpen,
-        final int bufSize) {
-        this(new TailablePath(file.toPath()), charset, listener, Duration.ofMillis(delayMillis), end, reOpen, bufSize, DEFAULT_IGNORE_TOUCH);
+    public Tailer(final File file, final Charset charset, final TailerListener tailerListener, final long delayMillis, final boolean end, final boolean reOpen,
+            final int bufSize) {
+        this(new TailablePath(file.toPath()), charset, tailerListener, Duration.ofMillis(delayMillis), end, reOpen, bufSize, DEFAULT_IGNORE_TOUCH);
     }
 
     /**
      * Creates a Tailer for the given file, starting from the beginning, with the default delay of 1.0s.
      *
      * @param file The file to follow.
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public Tailer(final File file, final TailerListener listener) {
-        this(file, listener, DEFAULT_DELAY_MILLIS);
+    public Tailer(final File file, final TailerListener tailerListener) {
+        this(file, tailerListener, DEFAULT_DELAY_MILLIS);
     }
 
     /**
      * Creates a Tailer for the given file, starting from the beginning.
      *
      * @param file the file to follow.
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @param delayMillis the delay between checks of the file for new content in milliseconds.
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public Tailer(final File file, final TailerListener listener, final long delayMillis) {
-        this(file, listener, delayMillis, false);
+    public Tailer(final File file, final TailerListener tailerListener, final long delayMillis) {
+        this(file, tailerListener, delayMillis, false);
     }
 
     /**
      * Creates a Tailer for the given file, with a delay other than the default 1.0s.
      *
      * @param file the file to follow.
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @param delayMillis the delay between checks of the file for new content in milliseconds.
      * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file.
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public Tailer(final File file, final TailerListener listener, final long delayMillis, final boolean end) {
-        this(file, listener, delayMillis, end, IOUtils.DEFAULT_BUFFER_SIZE);
+    public Tailer(final File file, final TailerListener tailerListener, final long delayMillis, final boolean end) {
+        this(file, tailerListener, delayMillis, end, IOUtils.DEFAULT_BUFFER_SIZE);
     }
 
     /**
      * Creates a Tailer for the given file, with a delay other than the default 1.0s.
      *
      * @param file the file to follow.
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @param delayMillis the delay between checks of the file for new content in milliseconds.
      * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file.
      * @param reOpen if true, close and reopen the file between reading chunks
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public Tailer(final File file, final TailerListener listener, final long delayMillis, final boolean end, final boolean reOpen) {
-        this(file, listener, delayMillis, end, reOpen, IOUtils.DEFAULT_BUFFER_SIZE);
+    public Tailer(final File file, final TailerListener tailerListener, final long delayMillis, final boolean end, final boolean reOpen) {
+        this(file, tailerListener, delayMillis, end, reOpen, IOUtils.DEFAULT_BUFFER_SIZE);
     }
 
     /**
      * Creates a Tailer for the given file, with a specified buffer size.
      *
      * @param file the file to follow.
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @param delayMillis the delay between checks of the file for new content in milliseconds.
      * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file.
      * @param reOpen if true, close and reopen the file between reading chunks
      * @param bufferSize Buffer size
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public Tailer(final File file, final TailerListener listener, final long delayMillis, final boolean end, final boolean reOpen, final int bufferSize) {
-        this(file, DEFAULT_CHARSET, listener, delayMillis, end, reOpen, bufferSize);
+    public Tailer(final File file, final TailerListener tailerListener, final long delayMillis, final boolean end, final boolean reOpen, final int bufferSize) {
+        this(file, DEFAULT_CHARSET, tailerListener, delayMillis, end, reOpen, bufferSize);
     }
 
     /**
      * Creates a Tailer for the given file, with a specified buffer size.
      *
      * @param file the file to follow.
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @param delayMillis the delay between checks of the file for new content in milliseconds.
      * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file.
      * @param bufferSize Buffer size
      * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
      */
     @Deprecated
-    public Tailer(final File file, final TailerListener listener, final long delayMillis, final boolean end, final int bufferSize) {
-        this(file, listener, delayMillis, end, false, bufferSize);
+    public Tailer(final File file, final TailerListener tailerListener, final long delayMillis, final boolean end, final int bufferSize) {
+        this(file, tailerListener, delayMillis, end, false, bufferSize);
     }
 
     /**
      * Creates a Tailer for the given file, with a specified buffer size.
      *
      * @param tailable the file to follow.
      * @param charset the Charset to be used for reading the file
-     * @param listener the TailerListener to use.
+     * @param tailerListener the TailerListener to use.
      * @param delayDuration the delay between checks of the file for new content in milliseconds.
-     * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file.
+     * @param tailAtEnd Set to true to tail from the end of the file, false to tail from the beginning of the file.
      * @param reOpen if true, close and reopen the file between reading chunks
      * @param ignoreTouch if true, file timestamp changes without content change get ignored
      * @param bufferSize Buffer size
      */
-    private Tailer(final Tailable tailable, final Charset charset, final TailerListener listener, final Duration delayDuration, final boolean end,
-        final boolean reOpen, final int bufferSize, final boolean ignoreTouch) {
+    private Tailer(final Tailable tailable, final Charset charset, final TailerListener tailerListener, final Duration delayDuration, final boolean tailAtEnd,
+            final boolean reOpen, final int bufferSize, final boolean ignoreTouch) {
         this.tailable = Objects.requireNonNull(tailable, "tailable");
-        this.listener = Objects.requireNonNull(listener, "listener");
+        this.listener = Objects.requireNonNull(tailerListener, "listener");
         this.delayDuration = delayDuration;
-        this.tailAtEnd = end;
+        this.tailFromEnd = tailAtEnd;
         this.inbuf = IOUtils.byteArray(bufferSize);
-
         // Save and prepare the listener
-        listener.init(this);
+        tailerListener.init(this);
         this.reOpen = reOpen;
         this.charset = charset;
         this.ignoreTouch = ignoreTouch;
     }
 
+    /**
+     * Creates a Tailer for the given file, with a specified buffer size.
+     *
+     * @param builder holds construction data.
+     */
+    private Tailer(final Builder builder) {
+        this.tailable = Objects.requireNonNull(builder.tailable, "tailable");
+        this.listener = Objects.requireNonNull(builder.tailerListener, "listener");
+        this.delayDuration = builder.delayDuration;
+        this.tailFromEnd = builder.tailFromEnd;
+        this.inbuf = IOUtils.byteArray(builder.getBufferSize());
+        // Save and prepare the listener
+        listener.init(this);
+        this.reOpen = builder.reOpen;
+        this.charset = builder.getCharset();
+        this.ignoreTouch = builder.ignoreTouch;
+    }
+
     /**
      * Requests the tailer to complete its current loop and return.
      */
@@ -982,7 +999,7 @@ public void run() {
                     ThreadUtils.sleep(delayDuration);
                 } else {
                     // The current position in the file
-                    position = tailAtEnd ? tailable.size() : 0;
+                    position = tailFromEnd ? tailable.size() : 0;
                     last = tailable.lastModifiedFileTime();
                     reader.seek(position);
                 }