ConcurrentInputShop (TrueZIP Kernel 7.2-rc-2 API)

java.lang.Object
- de.schlichtherle.truezip.entry.DecoratingEntryContainer<E,I>
- - de.schlichtherle.truezip.socket.DecoratingInputShop<E,InputShop<E>>
  - - de.schlichtherle.truezip.socket.ConcurrentInputShop<E>

Type Parameters:
E - The type of the entries.

All Implemented Interfaces:

EntryContainer<E>, InputService<E>, InputShop<E>, java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<E>

Direct Known Subclasses:

FsDefaultArchiveController.Input
```
@ThreadSafe
public class ConcurrentInputShop<E extends Entry>
extends DecoratingInputShop<E,InputShop<E>>
```
Decorates another input shop to add accounting and multithreading synchronization for all input streams or read only files created by the decorated input shop.

Author:

Christian Schlichtherle

See Also:
ConcurrentOutputShop

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`ConcurrentInputShop.ConcurrentInputStream`
`private class`	`ConcurrentInputShop.ConcurrentReadOnlyFile`
`private class`	`ConcurrentInputShop.SynchronizedConcurrentInputStream`
`private class`	`ConcurrentInputShop.SynchronizedConcurrentReadOnlyFile`

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.lang.String`	`CLASS_NAME`
`private boolean`	`closed`
`private static java.util.logging.Logger`	`logger`
`private java.util.Map<java.io.Closeable,java.lang.Thread>`	`threads` The pool of all open entry streams.

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

Constructor Summary

Constructors
Constructor and Description

ConcurrentInputShop(InputShop<E> input)
Constructs a concurrent input shop.

Constructors
Constructor and Description
`ConcurrentInputShop(InputShop<E> input)` Constructs a concurrent input shop.

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`assertNotShopClosed()` Needs to be externally synchronized!
`void`	`close()` Closes this concurrent output shop.
`<X extends java.lang.Exception> void`	`closeAll(ExceptionHandler<java.io.IOException,X> handler)` Closes and disconnects all entry input streams and read only file created by this concurrent input shop.
`InputSocket<? extends E>`	`getInputSocket(java.lang.String name)` Returns an input socket for reading from the entry with the given name.
`private int`	`threadStreams()` Returns the number of streams opened by the current thread.
`int`	`waitCloseOthers(long timeout)` Waits until all entry input streams and read only files which have been opened by other threads get closed or a timeout occurs.

Methods inherited from class de.schlichtherle.truezip.entry.DecoratingEntryContainer
getEntry, getSize, iterator, toString

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

Methods inherited from interface de.schlichtherle.truezip.entry.EntryContainer
getEntry, getSize, iterator

- Field Detail
  - CLASS_NAME
```
private static final java.lang.String CLASS_NAME
```
  - logger
```
private static final java.util.logging.Logger logger
```
  - threads
```
private final java.util.Map<java.io.Closeable,java.lang.Thread> threads
```
    The pool of all open entry streams. This is implemented as a map where the keys are the streams and the value is the current thread. The weak hash map allows the garbage collector to pick up an entry stream if there are no more references to it. This reduces the likeliness of an InputBusyException in case a sloppy client application has forgot to close a stream before this input shop gets closed.
  - closed
```
private volatile boolean closed
```
- Constructor Detail
  - ConcurrentInputShop
```
public ConcurrentInputShop(InputShop<E> input)
```
    Constructs a concurrent input shop.
    
    Parameters:
    input - the shop to decorate.
    
    Throws:
    
    java.lang.NullPointerException - if input is null.
- Method Detail
  - waitCloseOthers
```
public final int waitCloseOthers(long timeout)
```
    Waits until all entry input streams and read only files which have been opened by other threads get closed or a timeout occurs. If the current thread is interrupted while waiting, a warning message is logged using java.util.logging and this method returns.
    Unless otherwise prevented, another thread could immediately open another stream upon return of this method. So there is actually no guarantee that really all streams are closed upon return of this method - use carefully!
    
    Returns:
    The number of all open streams.
  - threadStreams
```
private int threadStreams()
```
    Returns the number of streams opened by the current thread.
  - closeAll
```
public final <X extends java.lang.Exception> void closeAll(ExceptionHandler<java.io.IOException,X> handler)
                    throws X extends java.lang.Exception
```
    Closes and disconnects all entry input streams and read only file created by this concurrent input shop. Disconnecting means that any subsequent operation on the entry streams will throw an IOException, with the exception of their close() method.
    
    Throws:
    
    X extends java.lang.Exception
  - close
```
public final void close()
                 throws java.io.IOException
```
    Closes this concurrent output shop.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class DecoratingInputShop<E extends Entry,InputShop<E extends Entry>>
    
    Throws:
    
    java.lang.IllegalStateException - If any open input streams or read only files are detected.
    
    java.io.IOException
    See Also:
    closeAll(de.schlichtherle.truezip.util.ExceptionHandler<java.io.IOException, X>)
  - assertNotShopClosed
```
private void assertNotShopClosed()
                          throws java.io.IOException
```
    Needs to be externally synchronized!
    
    Throws:
    
    java.io.IOException
  - getInputSocket
```
public final InputSocket<? extends E> getInputSocket(java.lang.String name)
```
    Description copied from interface: InputService
    
    Returns an input socket for reading from the entry with the given name.
    
    Specified by:
    
    getInputSocket in interface InputService<E extends Entry>
    
    Overrides:
    
    getInputSocket in class DecoratingInputShop<E extends Entry,InputShop<E extends Entry>>
    
    Parameters:
    name - an entry name.
    
    Returns:
    An input socket for reading from the entry with the given name.

Class ConcurrentInputShop<E extends Entry>

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

Methods inherited from interface de.schlichtherle.truezip.entry.EntryContainer

Field Detail

CLASS_NAME

logger

threads

closed

Constructor Detail

ConcurrentInputShop

Method Detail

waitCloseOthers

threadStreams

closeAll

close

assertNotShopClosed

getInputSocket