org.apache.juneau.internal

Class FileReaderBuilder

java.lang.Object

org.apache.juneau.internal.FileReaderBuilder

public final class FileReaderBuilder
extends Object

Utility class for creating FileReader objects.

Constructor Summary

Constructors

Constructor and Description
FileReaderBuilder()

Method Summary

Modifier and Type	Method and 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(Charset cs) Sets the character encoding of the file.
FileReaderBuilder	charset(String 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 Detail

FileReaderBuilder

public FileReaderBuilder()

Method Detail

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 (for method chaining).

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 (for method chaining).

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 (for method chaining).

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 (for method chaining).

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 (for method chaining).

build

public Reader build()
             throws FileNotFoundException

Creates a new File reader.

Returns:

A new File reader.

Throws:

FileNotFoundException - If file could not be found.