SynchronizedReadOnlyFile (TrueZIP Kernel 7.2-rc-2 API)

java.lang.Object
- de.schlichtherle.truezip.rof.AbstractReadOnlyFile
- - de.schlichtherle.truezip.rof.DecoratingReadOnlyFile
  - - de.schlichtherle.truezip.rof.SynchronizedReadOnlyFile

All Implemented Interfaces:

ReadOnlyFile, java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

ConcurrentInputShop.SynchronizedConcurrentReadOnlyFile
```
@ThreadSafe
public class SynchronizedReadOnlyFile
extends DecoratingReadOnlyFile
```
A decorator which synchronizes all access to a ReadOnlyFile via an object provided to its constructor.

Author:

Christian Schlichtherle

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.Object lock
The object to synchronize on - never null.
- Fields inherited from class de.schlichtherle.truezip.rof.DecoratingReadOnlyFile
  delegate

Fields
Modifier and Type	Field and Description
`protected java.lang.Object`	`lock` The object to synchronize on - never `null`.

Constructor Summary

Constructors
Constructor and Description
`SynchronizedReadOnlyFile(ReadOnlyFile rof)` Constructs a new synchronized read only file.
`SynchronizedReadOnlyFile(ReadOnlyFile rof, java.lang.Object lock)` Constructs a new synchronized read only file.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this read-only file and releases any non-heap resources allocated for it.
`long`	`getFilePointer()` Returns the current byte position in the file as a zero-based index.
`long`	`length()` Returns the length of the file in bytes.
`int`	`read()` Reads and returns the next byte or -1 if the end of the file has been reached.
`int`	`read(byte[] b, int off, int len)` Reads up to `len` bytes of data from this read only file into the given array.
`void`	`seek(long pos)` Sets the current byte position in the file as a zero-based index at which the next read occurs.

Methods inherited from class de.schlichtherle.truezip.rof.DecoratingReadOnlyFile
toString

Methods inherited from class de.schlichtherle.truezip.rof.AbstractReadOnlyFile
read, readFully, readFully

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

- Field Detail
  - lock
```
protected final java.lang.Object lock
```
    The object to synchronize on - never null.
- Constructor Detail
  - SynchronizedReadOnlyFile
```
public SynchronizedReadOnlyFile(ReadOnlyFile rof)
```
    Constructs a new synchronized read only file. This object will synchronize on itself.
    
    Parameters:
    rof - the read only file to wrap in this decorator.
  - SynchronizedReadOnlyFile
```
public SynchronizedReadOnlyFile(ReadOnlyFile rof,
                        java.lang.Object lock)
```
    Constructs a new synchronized read only file.
    
    Parameters:
    rof - the input stream to wrap in this decorator.
    lock - the object to synchronize on. If null, then this object is used, not the stream.
- Method Detail
  - length
```
public long length()
            throws java.io.IOException
```
    Description copied from interface: ReadOnlyFile
    
    Returns the length of the file in bytes.
    
    Specified by:
    
    length in interface ReadOnlyFile
    
    Overrides:
    
    length in class DecoratingReadOnlyFile
    
    Throws:
    
    java.io.IOException
  - getFilePointer
```
public long getFilePointer()
                    throws java.io.IOException
```
    Description copied from interface: ReadOnlyFile
    
    Returns the current byte position in the file as a zero-based index.
    
    Specified by:
    
    getFilePointer in interface ReadOnlyFile
    
    Overrides:
    
    getFilePointer in class DecoratingReadOnlyFile
    
    Throws:
    
    java.io.IOException
  - seek
```
public void seek(long pos)
          throws java.io.IOException
```
    Description copied from interface: ReadOnlyFile
    
    Sets the current byte position in the file as a zero-based index at which the next read occurs. Whether the offset may be set beyond the end of the file is up to the implementor. For example, the DefaultReadOnlyFile subclass RandomAccessFile passes "r" as a parameter to the superclass constructor. With Sun's JSE implementation, on the Windows platform this implementation allows to seek past the end of file, but on the Linux platform it doesn't.
    
    Specified by:
    
    seek in interface ReadOnlyFile
    
    Overrides:
    
    seek in class DecoratingReadOnlyFile
    
    Parameters:
    pos - The current byte position as a zero-based index.
    
    Throws:
    
    java.io.IOException - If pos is less than 0 or if an I/O error occurs.
  - read
```
public int read()
         throws java.io.IOException
```
    Description copied from interface: ReadOnlyFile
    
    Reads and returns the next byte or -1 if the end of the file has been reached.
    
    Specified by:
    
    read in interface ReadOnlyFile
    
    Overrides:
    
    read in class DecoratingReadOnlyFile
    
    Throws:
    
    java.io.IOException
  - read
```
public int read(byte[] b,
       int off,
       int len)
         throws java.io.IOException
```
    Description copied from interface: ReadOnlyFile
    
    Reads up to len bytes of data from this read only file into the given array. This method blocks until at least one byte of input is available.
    
    Specified by:
    
    read in interface ReadOnlyFile
    
    Overrides:
    
    read in class DecoratingReadOnlyFile
    
    Parameters:
    b - The buffer to fill with data.
    off - The start offset of the data.
    len - The maximum number of bytes to read.
    
    Returns:
    The total number of bytes read, or -1 if there is no more data because the end of the file has been reached.
    
    Throws:
    
    java.io.IOException - On any I/O related issue.
  - close
```
public void close()
           throws java.io.IOException
```
    Description copied from interface: ReadOnlyFile
    
    Closes this read-only file and releases any non-heap resources allocated for it.
    
    Specified by:
    
    close in interface ReadOnlyFile
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class DecoratingReadOnlyFile
    
    Throws:
    
    java.io.IOException

Class SynchronizedReadOnlyFile

Field Summary

Fields inherited from class de.schlichtherle.truezip.rof.DecoratingReadOnlyFile

Constructor Summary

Method Summary

Methods inherited from class de.schlichtherle.truezip.rof.DecoratingReadOnlyFile

Methods inherited from class de.schlichtherle.truezip.rof.AbstractReadOnlyFile

Methods inherited from class java.lang.Object

Field Detail

lock

Constructor Detail

SynchronizedReadOnlyFile

SynchronizedReadOnlyFile

Method Detail

length

getFilePointer

seek

read

read

close