com.github.jferard.fastods

Class OdsFileDirectWriter

java.lang.Object

com.github.jferard.fastods.OdsFileDirectWriter

All Implemented Interfaces:

NamedOdsFileWriter

public class OdsFileDirectWriter
extends Object
implements NamedOdsFileWriter

The OdsFileDirectWriter class represents a direct writer. It asks the flusher to flush its data directly into the zip writer.

Author:

Julien Férard, Martin Schulz

Method Summary

Modifier and Type	Method and Description
static OdsFileWriterBuilder	builder(Logger logger, NamedOdsDocument document) Return a builder for direct writer
void	close() Close this writer
NamedOdsDocument	document()
void	save() Save the new file.
void	update(OdsAsyncFlusher flusher) Update the writer with a flusher

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static OdsFileWriterBuilder builder(Logger logger,
                                           NamedOdsDocument document)

Return a builder for direct writer

Parameters:

logger - the logger

document - the document to write

Returns:

the builder

close

public void close()
           throws IOException

Description copied from interface: NamedOdsFileWriter

Close this writer

Specified by:

close in interface NamedOdsFileWriter

Throws:

IOException - if an I/O error occurs

document

public NamedOdsDocument document()

Specified by:

document in interface NamedOdsFileWriter

Returns:

the inner document

save

public void save()
          throws IOException

Description copied from interface: NamedOdsFileWriter

Save the new file.

Specified by:

save in interface NamedOdsFileWriter

Throws:

IOException - If an I/O error occurs

update

public void update(OdsAsyncFlusher flusher)
            throws IOException

Description copied from interface: NamedOdsFileWriter

Update the writer with a flusher

Specified by:

update in interface NamedOdsFileWriter

Parameters:

flusher - the chosen flusher

Throws:

IOException - if an I/O error occurs