FsMultiplexedArchiveOutputShop (TrueZIP Kernel 7.2-rc-2 API)

java.lang.Object
- de.schlichtherle.truezip.entry.DecoratingEntryContainer<E,O>
- - de.schlichtherle.truezip.socket.DecoratingOutputShop<AE,OutputShop<AE>>
  - - de.schlichtherle.truezip.fs.archive.FsMultiplexedArchiveOutputShop<AE>

Type Parameters:
AE - The type of the archive entries.

All Implemented Interfaces:

EntryContainer<AE>, OutputService<AE>, OutputShop<AE>, java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<AE>
```
@NotThreadSafe
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public class FsMultiplexedArchiveOutputShop<AE extends FsArchiveEntry>
extends DecoratingOutputShop<AE,OutputShop<AE>>
```
Decorates annother output shop to support a virtually unlimited number of entries which may be written concurrently while actually at most one entry is written concurrently to the decorated output shop. If there is more than one entry to be written concurrently, the additional entries are buffered to an I/O entry allocated from an I/O pool and copied to the decorated output shop upon a call to their OutputStream.close() method. Note that this implies that the close() method may fail with an IOException.

Author:

Christian Schlichtherle

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`FsMultiplexedArchiveOutputShop.BufferedEntriesIterator`
`private class`	`FsMultiplexedArchiveOutputShop.BufferedEntryOutputStream` This entry output stream writes the archive entry to an `I/O pool entry`.
`private class`	`FsMultiplexedArchiveOutputShop.EntryOutputStream` This entry output stream writes directly to this output shop.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.Map<java.lang.String,FsMultiplexedArchiveOutputShop.BufferedEntryOutputStream>`	`buffers` The map of temporary archive entries which have not yet been written to the output output archive.
`private boolean`	`busy`
`private IOPool<?>`	`pool`

Fields inherited from class de.schlichtherle.truezip.entry.DecoratingEntryContainer
delegate

Constructor Summary

Constructors
Constructor and Description

FsMultiplexedArchiveOutputShop(OutputShop<AE> output, IOPool<?> pool)
Constructs a new FsMultiplexedArchiveOutputShop.

Constructors
Constructor and Description
`FsMultiplexedArchiveOutputShop(OutputShop<AE> output, IOPool<?> pool)` Constructs a new `FsMultiplexedArchiveOutputShop`.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`AE`	`getEntry(java.lang.String name)` Returns the entry for the given `name` or `null` if no entry with this name exists in this container.
`OutputSocket<? extends AE>`	`getOutputSocket(AE entry)` Returns an output socket for writing to the given entry.
`int`	`getSize()` Returns the number of entries in this container.
`boolean`	`isBusy()` Returns whether the container output archive is busy writing an archive entry or not.
`java.util.Iterator<AE>`	`iterator()` Returns a new iterator for all entries in this container.
`private void`	`storeBuffers()`

Methods inherited from class de.schlichtherle.truezip.entry.DecoratingEntryContainer
toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - pool
```
private final IOPool<?> pool
```
  - buffers
```
private final java.util.Map<java.lang.String,FsMultiplexedArchiveOutputShop.BufferedEntryOutputStream> buffers
```
    The map of temporary archive entries which have not yet been written to the output output archive.
  - busy
```
private boolean busy
```
    See Also:
    isBusy()
- Constructor Detail
  - FsMultiplexedArchiveOutputShop
```
public FsMultiplexedArchiveOutputShop(OutputShop<AE> output,
                              IOPool<?> pool)
```
    Constructs a new FsMultiplexedArchiveOutputShop.
    
    Parameters:
    output - the decorated output archive.
    
    Throws:
    
    java.lang.NullPointerException - if any parameter is null.
- Method Detail
  - getSize
```
public int getSize()
```
    Description copied from interface: EntryContainer
    
    Returns the number of entries in this container.
    
    Specified by:
    
    getSize in interface EntryContainer<AE extends FsArchiveEntry>
    
    Overrides:
    
    getSize in class DecoratingEntryContainer<AE extends FsArchiveEntry,OutputShop<AE extends FsArchiveEntry>>
  - iterator
```
public java.util.Iterator<AE> iterator()
```
    Description copied from interface: EntryContainer
    
    Returns a new iterator for all entries in this container.
    First, the iteration must be consistent: Multiple iterators must iterate the same entries in the same order again unless the set of entries has changed.
    Next, the iteration should also reflect the natural order of the entries in this container. For example, if this container represents an archive file, the iteration should reflect the natural order of the entries in the archive file.
    
    Specified by:
    
    iterator in interface EntryContainer<AE extends FsArchiveEntry>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<AE extends FsArchiveEntry>
    
    Overrides:
    
    iterator in class DecoratingEntryContainer<AE extends FsArchiveEntry,OutputShop<AE extends FsArchiveEntry>>
    
    Returns:
    A new iterator over all entries in this container.
  - getEntry
```
@CheckForNull
public AE getEntry(java.lang.String name)
```
    Description copied from interface: EntryContainer
    
    Returns the entry for the given name or null if no entry with this name exists in this container.
    
    Specified by:
    
    getEntry in interface EntryContainer<AE extends FsArchiveEntry>
    
    Overrides:
    
    getEntry in class DecoratingEntryContainer<AE extends FsArchiveEntry,OutputShop<AE extends FsArchiveEntry>>
    
    Parameters:
    name - an entry name.
    
    Returns:
    The entry for the given name or null if no entry with this name exists in this container.
  - getOutputSocket
```
public OutputSocket<? extends AE> getOutputSocket(AE entry)
```
    Description copied from interface: OutputService
    
    Returns an output socket for writing to the given entry.
    
    Specified by:
    
    getOutputSocket in interface OutputService<AE extends FsArchiveEntry>
    
    Overrides:
    
    getOutputSocket in class DecoratingOutputShop<AE extends FsArchiveEntry,OutputShop<AE extends FsArchiveEntry>>
    
    Parameters:
    entry - the entry, which will be the local target of the returned output socket.
    
    Returns:
    An output socket for writing to the given entry.
  - isBusy
```
public boolean isBusy()
```
    Returns whether the container output archive is busy writing an archive entry or not.
  - close
```
public void close()
           throws java.io.IOException
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class DecoratingOutputShop<AE extends FsArchiveEntry,OutputShop<AE extends FsArchiveEntry>>
    
    Throws:
    
    java.io.IOException
  - storeBuffers
```
private void storeBuffers()
                   throws java.io.IOException
```
    Throws:
    
    java.io.IOException

Class FsMultiplexedArchiveOutputShop<AE extends FsArchiveEntry>

Nested Class Summary

Field Summary

Fields inherited from class de.schlichtherle.truezip.entry.DecoratingEntryContainer

Constructor Summary

Method Summary

Methods inherited from class de.schlichtherle.truezip.entry.DecoratingEntryContainer

Methods inherited from class java.lang.Object

Field Detail

pool

buffers

busy

Constructor Detail

FsMultiplexedArchiveOutputShop

Method Detail

getSize

iterator

getEntry

getOutputSocket

isBusy

close

storeBuffers