com.screenscraper.util.suppliers

Class FileLineSupplier

java.lang.Object

com.screenscraper.util.suppliers.FileLineSupplier

All Implemented Interfaces:

ResettableSupplier<java.lang.String>, java.io.Closeable, java.lang.AutoCloseable, java.util.function.Supplier<java.lang.String>

public class FileLineSupplier
extends java.lang.Object
implements ResettableSupplier<java.lang.String>, java.io.Closeable

Supplier to return a file one line at a time. This skips empty lines. This is not thread safe. Note the close method should be called for this supplier to clean up resources. Note that while this implements ResettableSupplier if you pass in a reader directly instead of a file, the reset call will fail

Version:

7.0.12a

Constructor Summary

Constructors

Constructor and Description
FileLineSupplier(java.io.BufferedReader reader) Create a supplier by passing a reader directly.
FileLineSupplier(java.io.File file) Create a supplier by passing a file
FileLineSupplier(java.io.File file, java.nio.charset.Charset charset) Create a supplier by passing a file
FileLineSupplier(java.nio.file.Path path) Create a supplier by passing a file
FileLineSupplier(java.nio.file.Path path, java.nio.charset.Charset charset) Create a supplier by passing a file

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	equals(java.lang.Object o)
java.lang.String	get()
int	hashCode()
void	reset() Resets the state of this supplier so that the next call to get() returns as if it were the first time the method were called
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FileLineSupplier

public FileLineSupplier(@NotNull
                        java.io.File file)
                 throws java.io.IOException

Create a supplier by passing a file

Parameters:

file - The file to read using the system default character set

Throws:

java.io.IOException - On error opening the file for read

FileLineSupplier

public FileLineSupplier(@NotNull
                        java.io.File file,
                        @NotNull
                        java.nio.charset.Charset charset)
                 throws java.io.IOException

Create a supplier by passing a file

Parameters:

file - The file to read

charset - The character set used for reading the file

Throws:

java.io.IOException - On error opening the file for read

FileLineSupplier

public FileLineSupplier(@NotNull
                        java.nio.file.Path path)
                 throws java.io.IOException

Create a supplier by passing a file

Parameters:

path - The file to read as a path using the system default character set

Throws:

java.io.IOException - On error opening the file for read

FileLineSupplier

public FileLineSupplier(@NotNull
                        java.nio.file.Path path,
                        @NotNull
                        java.nio.charset.Charset charset)
                 throws java.io.IOException

Create a supplier by passing a file

Parameters:

path - The file to read as a path

charset - The character set used for reading the file

Throws:

java.io.IOException - On error opening the file for read

FileLineSupplier

public FileLineSupplier(@NotNull
                        java.io.BufferedReader reader)

Create a supplier by passing a reader directly. Note using this method will cause the reset call to throw an exception

Parameters:

reader - A reader to read from

Method Detail

reset

public void reset()

Description copied from interface: ResettableSupplier

Resets the state of this supplier so that the next call to get() returns as if it were the first time the method were called

Specified by:

reset in interface ResettableSupplier<java.lang.String>

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

get

@Nullable
public java.lang.String get()

Specified by:

get in interface java.util.function.Supplier<java.lang.String>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object