com.github.jferard.fastods

Class OdsFileWriterBuilder

java.lang.Object

com.github.jferard.fastods.OdsFileWriterBuilder

public class OdsFileWriterBuilder
extends Object

Author:

Julien Férard, Martin Schulz

Method Summary

Modifier and Type	Method and Description
NamedOdsFileWriter	build()
OdsFileWriterBuilder	file(File file) Beware: this locks the file until the writer is closed
OdsFileWriterBuilder	file(String filename) Beware: this locks the file until the writer is closed
OdsFileWriterBuilder	openResult(FileOpenResult lockResult) Locks the file
OdsFileWriterBuilder	outputStream(OutputStream out)
OdsFileWriterBuilder	zipBuilder(ZipUTF8WriterBuilderImpl builder)

Methods inherited from class java.lang.Object

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

Method Detail

build

public NamedOdsFileWriter build()

Returns:

the writer for the ods file

file

public OdsFileWriterBuilder file(String filename)
                          throws FileNotFoundException

Beware: this locks the file until the writer is closed

Parameters:

filename - the name of the destination file

Returns:

this for fluent style

Throws:

FileNotFoundException - if the file does not exist.

file

public OdsFileWriterBuilder file(File file)
                          throws FileNotFoundException

Beware: this locks the file until the writer is closed

Parameters:

file - the destination file

Returns:

this for fluent style

Throws:

FileNotFoundException - if the file does not exist

outputStream

public OdsFileWriterBuilder outputStream(OutputStream out)

Parameters:

out - where to write

Returns:

this for fluent style

openResult

public OdsFileWriterBuilder openResult(FileOpenResult lockResult)
                                throws FileNotFoundException

Locks the file

Parameters:

lockResult - the result of a file lock

Returns:

this for fluent style

Throws:

FileNotFoundException - the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

zipBuilder

public OdsFileWriterBuilder zipBuilder(ZipUTF8WriterBuilderImpl builder)

Parameters:

builder - a builder for the ZipOutputStream and the Writer (buffers, level, ...)

Returns:

this for fluent style