de.schlichtherle.io
Class ArchiveControllers.LiveArchiveStatistics

java.lang.Object
  de.schlichtherle.io.ArchiveControllers.LiveArchiveStatistics

All Implemented Interfaces:

ArchiveStatistics

Enclosing class:

ArchiveControllers

private static final class ArchiveControllers.LiveArchiveStatistics
extends Object
implements ArchiveStatistics

Field Summary

private static ArchiveControllers.LiveArchiveStatistics

SINGLETON

Constructor Summary

private

ArchiveControllers.LiveArchiveStatistics() You cannot instantiate this singleton class.

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().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SINGLETON

private static final ArchiveControllers.LiveArchiveStatistics SINGLETON

Constructor Detail

ArchiveControllers.LiveArchiveStatistics

private ArchiveControllers.LiveArchiveStatistics()

You cannot instantiate this singleton class.

Method Detail

getUpdateTotalByteCountRead

public long getUpdateTotalByteCountRead()

Description copied from interface: ArchiveStatistics

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.

Specified by:

getUpdateTotalByteCountRead in interface ArchiveStatistics

See Also:

File.update(), File.umount()

getUpdateTotalByteCountWritten

public long getUpdateTotalByteCountWritten()

Description copied from interface: ArchiveStatistics

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.

Specified by:

getUpdateTotalByteCountWritten in interface ArchiveStatistics

See Also:

File.update(), File.umount()

getArchivesTotal

public int getArchivesTotal()

Description copied from interface: ArchiveStatistics

Returns the total number of archives operated by this package.

Specified by:

getArchivesTotal in interface ArchiveStatistics

getArchivesTouched

public int getArchivesTouched()

Description copied from interface: ArchiveStatistics

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.

Specified by:

getArchivesTouched in interface ArchiveStatistics

getTopLevelArchivesTotal

public int getTopLevelArchivesTotal()

Description copied from interface: ArchiveStatistics

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

Specified by:

getTopLevelArchivesTotal in interface ArchiveStatistics

getTopLevelArchivesTouched

public int getTopLevelArchivesTouched()

Description copied from interface: ArchiveStatistics

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.

Specified by:

getTopLevelArchivesTouched in interface ArchiveStatistics