com.github.jferard.fastods

Class AnonymousOdsFileWriter

java.lang.Object

com.github.jferard.fastods.AnonymousOdsFileWriter

public class AnonymousOdsFileWriter
extends Object

An ods file writer. It contains a document and is responsible for the recording. Anonymous means that the destination file is not set. The content of the document is only flushed once, when the document is saved. That means that one doesn't have to define the style early.

Author:

Julien Férard, Martin Schulz

Method Summary

Modifier and Type	Method and Description
OdsDocument	document()
void	save(OutputStream out) Writes the document to a stream.
void	save(OutputStream out, ZipUTF8WriterBuilderImpl builder) Deprecated. use `save(ZipUTF8Writer writer)`
void	save(ZipUTF8Writer writer) Writes the document to a writer.
void	saveAs(File file) Save the new file.
void	saveAs(File file, ZipUTF8WriterBuilder builder) Save the document to file.
void	saveAs(String filename) Save the new file.
void	saveAs(String filename, ZipUTF8WriterBuilder builder) Save the document to filename.

Methods inherited from class java.lang.Object

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

Method Detail

document

public OdsDocument document()

Returns:

the underlying document, under the interface

save

public void save(OutputStream out)
          throws IOException

Writes the document to a stream. WARNING: The user shall close the stream (since 0.6.1).

Parameters:

out - The OutputStream that should be used.

Throws:

IOException - The file can't be saved.

save

@Deprecated
public void save(OutputStream out,
                             ZipUTF8WriterBuilderImpl builder)
                      throws IOException

Deprecated. use `save(ZipUTF8Writer writer)`

Writes the document to a stream. WARNING: The user shall close the stream (since 0.6.1).

Parameters:

out - The OutputStream that should be used.

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

Throws:

IOException - The file can't be saved.

save

public void save(ZipUTF8Writer writer)
          throws IOException

Writes the document to a writer. The use shall close the writer. WARNING: The user shall `finish` and `close` the writer (since 0.6.1).

Parameters:

writer - the ZipUTF8WriterImpl that should be used

Throws:

IOException - If an I/O error occurs during the save

saveAs

public void saveAs(String filename)
            throws IOException

Save the new file.

Parameters:

filename - the name of the destination file

Throws:

IOException - If an I/O error occurs during the save

saveAs

public void saveAs(File file)
            throws IOException

Save the new file.

Parameters:

file - the destination file

Throws:

IOException - If an I/O error occurs

saveAs

public void saveAs(String filename,
                   ZipUTF8WriterBuilder builder)
            throws IOException

Save the document to filename.

Parameters:

filename - the name of the destination file

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

Throws:

IOException - if the file was not saved

saveAs

public void saveAs(File file,
                   ZipUTF8WriterBuilder builder)
            throws IOException

Save the document to file.

Parameters:

file - the destination file

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

Throws:

IOException - if the file was not saved