net.java.truevfs.kernel.spec.cio

Class MultiplexingOutputService<E extends net.java.truecommons.cio.MutableEntry>

java.lang.Object

net.java.truecommons.shed.UniqueObject

net.java.truecommons.cio.DecoratingContainer<E,net.java.truecommons.cio.OutputService<E>>

net.java.truecommons.cio.DecoratingOutputService<E>

net.java.truevfs.kernel.spec.cio.MultiplexingOutputService<E>

Type Parameters:

E - the type of the mutable entries.

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<E>, net.java.truecommons.cio.Container<E>, net.java.truecommons.cio.OutputService<E>, net.java.truecommons.shed.Stream<E>

Direct Known Subclasses:

OdfOutputService

@NotThreadSafe
public class MultiplexingOutputService<E extends net.java.truecommons.cio.MutableEntry>
extends net.java.truecommons.cio.DecoratingOutputService<E>

Decorates another output service to enable concurrent writing of multiple entries to the decorated container. Whenever an attempt is made to write more than one entry concurrently to this container, all but the first entry is transparently redirected to an I/O buffer. Whenever a redirected entry is close()d then, another attempt is made to copy the I/O buffer into the decorated container. If this container is still busy with writing an entry to the decorated container, then the copying is deferred until either another I/O buffer gets close()d or this container gets close()d, whatever happens first.

Note that this implies that close()ing an entry or this container may fail with an IOException.

Author:

Christian Schlichtherle

Field Summary

Fields inherited from class net.java.truecommons.cio.DecoratingContainer

container

Constructor Summary

Constructors

Constructor and Description
MultiplexingOutputService(net.java.truecommons.cio.IoBufferPool pool, net.java.truecommons.cio.OutputService<E> output) Constructs a new multiplexed output service.

Method Summary

Modifier and Type	Method and Description
void	close()
E	entry(String name)
boolean	isBusy() Returns whether the container output archive is busy writing an archive entry or not.
Iterator<E>	iterator()
net.java.truecommons.cio.OutputSocket<E>	output(E local)
int	size()

Methods inherited from class net.java.truecommons.cio.DecoratingContainer

toString

Methods inherited from class net.java.truecommons.shed.UniqueObject

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MultiplexingOutputService

public MultiplexingOutputService(net.java.truecommons.cio.IoBufferPool pool,
                                 @WillCloseWhenClosed
                                 net.java.truecommons.cio.OutputService<E> output)

Constructs a new multiplexed output service.

Parameters:

output - the decorated output service.

pool - the pool for buffering entry data.

Method Detail

close

@DischargesObligation
public void close()
                                 throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface net.java.truecommons.shed.Stream<E extends net.java.truecommons.cio.MutableEntry>

Overrides:

close in class net.java.truecommons.cio.DecoratingOutputService<E extends net.java.truecommons.cio.MutableEntry>

Throws:

IOException

entry

@CheckForNull
public E entry(String name)

Specified by:

entry in interface net.java.truecommons.cio.Container<E extends net.java.truecommons.cio.MutableEntry>

Overrides:

entry in class net.java.truecommons.cio.DecoratingContainer<E extends net.java.truecommons.cio.MutableEntry,net.java.truecommons.cio.OutputService<E extends net.java.truecommons.cio.MutableEntry>>

isBusy

public boolean isBusy()

Returns whether the container output archive is busy writing an archive entry or not.

Returns:

Whether the container output archive is busy writing an archive entry or not.

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E extends net.java.truecommons.cio.MutableEntry>

Specified by:

iterator in interface net.java.truecommons.cio.Container<E extends net.java.truecommons.cio.MutableEntry>

Overrides:

iterator in class net.java.truecommons.cio.DecoratingContainer<E extends net.java.truecommons.cio.MutableEntry,net.java.truecommons.cio.OutputService<E extends net.java.truecommons.cio.MutableEntry>>

output

public net.java.truecommons.cio.OutputSocket<E> output(E local)

Specified by:

output in interface net.java.truecommons.cio.OutputService<E extends net.java.truecommons.cio.MutableEntry>

Overrides:

output in class net.java.truecommons.cio.DecoratingOutputService<E extends net.java.truecommons.cio.MutableEntry>

size

public int size()

Specified by:

size in interface net.java.truecommons.cio.Container<E extends net.java.truecommons.cio.MutableEntry>

Overrides:

size in class net.java.truecommons.cio.DecoratingContainer<E extends net.java.truecommons.cio.MutableEntry,net.java.truecommons.cio.OutputService<E extends net.java.truecommons.cio.MutableEntry>>