com.cosylab.logging.client.cache

Interface ILogMap

All Known Implementing Classes:

LogBufferedFileCache, LogCache, LogFileCache, LogMultiFileCache

public interface ILogMap

The interface with the methods for the map of logs. The cache is implementing this interface.

Author:

acaproni

Method Summary

Modifier and Type	Method and Description
int	add(ILogEntry log) Add a log in the map
void	clear() Clear the Map i.e.
void	deleteLog(java.lang.Integer key) Remove a log from the Map
void	deleteLogs(java.util.Collection<java.lang.Integer> keys) Delete a set of logs
java.lang.Integer	getFirstLog() Return the key of the first valid log (FIFO).
int	getFirstLogs(int n, java.util.Collection<java.lang.Integer> keys) Append at most n keys from the first valid logs to the collection.
java.lang.Integer	getLastLog() Return the key of the last valid log (FIFO) The key of the last log is the key of the last inserted log but it can cheang if such log has been deleted
ILogEntry	getLog(java.lang.Integer key) Return a log eith the given key
int	getSize()
java.util.Iterator<ILogEntry>	iterator() Return an Iterator to browse the logs in the map.
java.util.Set<java.lang.Integer>	keySet() The keys in the map
void	replaceLog(java.lang.Integer key, ILogEntry log) Replace the log in the given position with the new one

Method Detail

clear

void clear()
    throws LogCacheException

Clear the Map i.e. remove all the logs and keys from the map

Throws:

LogCacheException

deleteLog

void deleteLog(java.lang.Integer key)
        throws LogCacheException

Remove a log from the Map

Parameters:

key -

Throws:

LogCacheException

deleteLogs

void deleteLogs(java.util.Collection<java.lang.Integer> keys)
         throws LogCacheException

Delete a set of logs

Parameters:

keys - The keys of logs to delete

Throws:

LogCacheException

getSize

int getSize()

Returns:

The number of logs in the map

keySet

java.util.Set<java.lang.Integer> keySet()

The keys in the map

Returns:

The key in the map

getLog

ILogEntry getLog(java.lang.Integer key)
          throws LogCacheException

Return a log eith the given key

Parameters:

key - The key of the logs

Returns:

The log with the given key

Throws:

LogCacheException

add

int add(ILogEntry log)
 throws LogCacheException

Add a log in the map

Parameters:

log - The log to add in the map

Returns:

The key of the added log

Throws:

LogCacheException

replaceLog

void replaceLog(java.lang.Integer key,
                ILogEntry log)
         throws LogCacheException

Replace the log in the given position with the new one

Parameters:

position - The position of the log to replace

log - The key (identifier) ot the log

Throws:

LogCacheException

iterator

java.util.Iterator<ILogEntry> iterator()

Return an Iterator to browse the logs in the map. The order the iterator returns the logs is that of the keys.

Returns:

an Iterator over the elements in this map

getLastLog

java.lang.Integer getLastLog()

Return the key of the last valid log (FIFO) The key of the last log is the key of the last inserted log but it can cheang if such log has been deleted

Returns:

The key of the last inserted log null if th cache is empty

getFirstLog

java.lang.Integer getFirstLog()

Return the key of the first valid log (FIFO). The key of the first log is 0 but it can change if the log 0 has been deleted.

Returns:

The key of the first log null if the cache is empty

getFirstLogs

int getFirstLogs(int n,
                 java.util.Collection<java.lang.Integer> keys)

Append at most n keys from the first valid logs to the collection. First here means first in the FIFO policy. The number of added keys can be less then n if the cache doesn't contain enough logs.

Parameters:

n - The desired number of keys of first logs

keys - The collection to add they keys to

Returns:

The number of keys effectively added