Package org.apache.juneau.common.utils

Class FileWriterBuilder

java.lang.Object

org.apache.juneau.common.utils.FileWriterBuilder

public class FileWriterBuilder
extends Object

Utility class for creating FileWriter objects.

Constructor Summary

Constructors

Constructor	Description
FileWriterBuilder()

Method Summary

Modifier and Type	Method	Description
FileWriterBuilder	append()	Sets the append mode on the writer to true.
FileWriterBuilder	buffered()	Sets the buffer mode on the writer to true.
Writer	build()	Creates a new File writer.
FileWriterBuilder	charset(String cs)	Sets the character encoding of the file.
FileWriterBuilder	charset(Charset cs)	Sets the character encoding of the file.
static FileWriterBuilder	create()	Creates a new builder.
static FileWriterBuilder	create(File file)	Creates a new builder initialized with the specified file.
static FileWriterBuilder	create(String path)	Creates a new builder initialized with the specified file path.
FileWriterBuilder	file(File file)	Sets the file being written to.
FileWriterBuilder	file(String path)	Sets the path of the file being written to.

Methods inherited from class java.lang.Object

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

Constructor Details

FileWriterBuilder

public FileWriterBuilder()

Method Details

create

public static FileWriterBuilder create()

Creates a new builder.

Returns:

A new builder.

create

public static FileWriterBuilder create(File file)

Creates a new builder initialized with the specified file.

Parameters:

file - The file being written to.

Returns:

A new builder.

create

public static FileWriterBuilder create(String path)

Creates a new builder initialized with the specified file path.

Parameters:

path - The file path being written to.

Returns:

A new builder.

file

public FileWriterBuilder file(File file)

Sets the file being written to.

Parameters:

file - The file being written to.

Returns:

This object.

file

public FileWriterBuilder file(String path)

Sets the path of the file being written to.

Parameters:

path - The path of the file being written to.

Returns:

This object.

charset

public FileWriterBuilder 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 FileWriterBuilder charset(String cs)

Sets the character encoding of the file.

Parameters:

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

Returns:

This object.

append

public FileWriterBuilder append()

Sets the append mode on the writer to true.

Returns:

This object.

buffered

public FileWriterBuilder buffered()

Sets the buffer mode on the writer to true.

Returns:

This object.

build

public Writer build()
             throws FileNotFoundException

Creates a new File writer.

Returns:

A new File writer.

Throws:

FileNotFoundException - If file could not be found.