com.github.jferard.fastods

Class OdsFileWriterAdapter

java.lang.Object

com.github.jferard.fastods.OdsFileWriterAdapter

All Implemented Interfaces:

NamedOdsFileWriter

public class OdsFileWriterAdapter
extends Object
implements NamedOdsFileWriter

The OdsFileWriterAdapter class represents an adapter to a writer. It stores a queue of flushers. Usage:

• A producer thread that writes on a OdsFileWriterAdapter.document()
• A consumer thread that uses the following structure to flush the data

 while (this.writerAdapter.isNotStopped()) {
     this.writerAdapter.waitForData();
     this.writerAdapter.flushAdaptee();
 }
 this.writerAdapter.flushAdaptee();
 

Author:

Julien Férard, Martin Schulz

Method Summary

Modifier and Type	Method and Description
void	close() Close this writer
static OdsFileWriterAdapter	create(Logger logger, NamedOdsFileWriter adaptee)
NamedOdsDocument	document()
void	flushAdaptee() Flushes all available flushers to the adaptee writer.
boolean	isNotStopped()
void	save() Save the new file.
void	update(OdsAsyncFlusher flusher) Update the writer with a flusher
void	waitForData() wait for the data

Methods inherited from class java.lang.Object

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

Method Detail

create

public static OdsFileWriterAdapter create(Logger logger,
                                          NamedOdsFileWriter adaptee)

Parameters:

logger - the logger

adaptee - the adaptee writer

Returns:

the new adapter

close

public void close()

Description copied from interface: NamedOdsFileWriter

Close this writer

Specified by:

close in interface NamedOdsFileWriter

document

public NamedOdsDocument document()

Specified by:

document in interface NamedOdsFileWriter

Returns:

the inner document

save

public void save()

Description copied from interface: NamedOdsFileWriter

Save the new file.

Specified by:

save in interface NamedOdsFileWriter

update

public void update(OdsAsyncFlusher flusher)

Description copied from interface: NamedOdsFileWriter

Update the writer with a flusher

Specified by:

update in interface NamedOdsFileWriter

Parameters:

flusher - the chosen flusher

flushAdaptee

public void flushAdaptee()
                  throws IOException

Flushes all available flushers to the adaptee writer. The thread falls asleep if we reach the end of the queue without a FinalizeFlusher.

Throws:

IOException - if the adaptee throws an IOException

isNotStopped

public boolean isNotStopped()

Returns:

true if the adapter is stopped

waitForData

public void waitForData()

wait for the data