de.schlichtherle.io
Interface ArchiveStatistics

public interface ArchiveStatistics

A proxy interface which encapsulates statistics about the total set of archives operated by this package. Client applications should never implement this interface; simply because there is no need to and because this interface may be amended over time.

Since:

TrueZIP 6.0

Version:

TrueZIP 6.7

Author:

Christian Schlichtherle

See Also:

File.getLiveArchiveStatistics()

Method Summary

int	getArchivesTotal() Returns the total number of archives operated by this package.
int	getArchivesTouched() Returns the number of archives which have been changed and hence need to be processed on the next call to File.update() or File.umount().
int	getTopLevelArchivesTotal() Returns the total number of top level archives operated by this package.
int	getTopLevelArchivesTouched() Returns the number of top level archives which have been changed and hence need to be processed on the next call to File.update() or File.umount().
long	getUpdateTotalByteCountRead() Returns the total number of bytes read from all non-enclosed archive files which are updated during File.update() or File.umount().
long	getUpdateTotalByteCountWritten() Returns the total number of bytes written to all non-enclosed archive files which are updated during File.update() or File.umount().

Method Detail

getUpdateTotalByteCountRead

long getUpdateTotalByteCountRead()

Returns the total number of bytes read from all non-enclosed archive files which are updated during File.update() or File.umount().

Please note that this method counts input from top level archive files which require an update only, i.e. archive files which are actually updated throughout the course of File.update() or File.update() and are not enclosed in other archive files and hence are present in the real file system.

This method is intended to be used for progress monitors and is a rough indicator about what is going on inside the TrueZIP API. The return value will be reset automatically where required, so if this value is going to 0 again you know that a knew update cycle has begun. Other than this, you should not rely on its actual value.

For an example how to use this please refer to the source code for nzip.ProgressMonitor in the base package.

See Also:

File.update(), File.umount()

getUpdateTotalByteCountWritten

long getUpdateTotalByteCountWritten()

Returns the total number of bytes written to all non-enclosed archive files which are updated during File.update() or File.umount().

Please note that this method counts output to top level archive files which require an update only, i.e. archive files which are actually updated throughout the course of File.update() or File.update() and are not enclosed in other archive files and hence are present in the real file system.

This method is intended to be used for progress monitors and is a rough indicator about what is going on inside the TrueZIP API. The return value will be reset automatically where required, so if this value is going to 0 again you know that a knew update cycle has begun. Other than this, you should not rely on its actual value.

For an example how to use this please refer to the source code for nzip.ProgressMonitor in the base package.

See Also:

File.update(), File.umount()

getArchivesTotal

int getArchivesTotal()

Returns the total number of archives operated by this package.

getArchivesTouched

int getArchivesTouched()

Returns the number of archives which have been changed and hence need to be processed on the next call to File.update() or File.umount(). Note that you should not use the returned value to call File.update() or File.umount() only conditionally - this is unreliable! Instead, you should always call one of those methods unconditionally.

getTopLevelArchivesTotal

int getTopLevelArchivesTotal()

Returns the total number of top level archives operated by this package.

getTopLevelArchivesTouched

int getTopLevelArchivesTouched()

Returns the number of top level archives which have been changed and hence need to be processed on the next call to File.update() or File.umount(). Note that you should not use the returned value to call File.update() or File.umount() only conditionally - this is unreliable! Instead, you should always call one of those methods unconditionally.