Package org.apache.juneau.common.utils

Class FileReaderBuilder

java.lang.Object

org.apache.juneau.common.utils.FileReaderBuilder

public class FileReaderBuilder
extends Object

Utility class for creating FileReader objects.

Constructor Summary

Constructors

Constructor	Description
FileReaderBuilder()

Method Summary

Modifier and Type	Method	Description
FileReaderBuilder	allowNoFile()	If called and the file is null or non-existent, then the build() command will return an empty reader instead of a FileNotFoundException.
Reader	build()	Creates a new File reader.
FileReaderBuilder	charset(String cs)	Sets the character encoding of the file.
FileReaderBuilder	charset(Charset cs)	Sets the character encoding of the file.
static FileReaderBuilder	create()	Creates a new builder.
static FileReaderBuilder	create(File file)	Creates a new builder initialized with the specified file.
FileReaderBuilder	file(File file)	Sets the file being written from.
FileReaderBuilder	file(String path)	Sets the path of the file being written from.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FileReaderBuilder

public FileReaderBuilder()

Method Details

create

public static FileReaderBuilder create()

Creates a new builder.

Returns:

A new builder.

create

public static FileReaderBuilder create(File file)

Creates a new builder initialized with the specified file.

Parameters:

file - The file being written to.

Returns:

A new builder.

file

public FileReaderBuilder file(File file)

Sets the file being written from.

Parameters:

file - The file being written from.

Returns:

This object.

file

public FileReaderBuilder file(String path)

Sets the path of the file being written from.

Parameters:

path - The path of the file being written from.

Returns:

This object.

charset

public FileReaderBuilder charset(Charset cs)

Sets the character encoding of the file.

Parameters:

cs - The character encoding. The default is Charset.defaultCharset().

Returns:

This object.

charset

public FileReaderBuilder charset(String cs)

Sets the character encoding of the file.

Parameters:

cs - The character encoding. The default is Charset.defaultCharset().

Returns:

This object.

allowNoFile

public FileReaderBuilder allowNoFile()

If called and the file is null or non-existent, then the build() command will return an empty reader instead of a FileNotFoundException.

Returns:

This object.

build

public Reader build()
             throws FileNotFoundException

Creates a new File reader.

Returns:

A new File reader.

Throws:

FileNotFoundException - If file could not be found.