com.SecurePlay
Interface SPLogInterface

All Known Implementing Classes:

SPLCircularLogClass, SPLLinkedListLogClass, SPLLogOneClass

public interface SPLogInterface

This is the interface for all the log classes.

Author:

IT GlobalSecure

See Also:

SecurePlay License Information

Method Summary

void	addEntry(java.lang.Object entry) Add a entry to the log object.
void	clear() Clear the log.
java.lang.Object	getCurrentEntry() This method returns the current entry in the Log - where the pointer indicates.
int	getLogLength() This method returns the number of logged objects in the log instance.
java.lang.String	getLogtype() This method returns the log type of the log class that implements this log interface.
java.lang.Object	getNextEntry() Get the next entry in the log.
java.lang.Object	getPreviousEntry() This method returns the previous entry in the log.
boolean	reset() Resets the log pointer.

Method Detail

addEntry

public void addEntry(java.lang.Object entry)

Add a entry to the log object.

Parameters:

entry - Object - An entry object that is used in a log.

clear

public void clear()

Clear the log.

reset

public boolean reset()

Resets the log pointer.

Returns:

result - Boolean: TRUE, to confirm the reset.

getNextEntry

public java.lang.Object getNextEntry()

Get the next entry in the log.

Returns:

obj - Object - An entry object

getPreviousEntry

public java.lang.Object getPreviousEntry()

This method returns the previous entry in the log.

Returns:

obj - Object - Previous Log Entry.

getCurrentEntry

public java.lang.Object getCurrentEntry()

This method returns the current entry in the Log - where the pointer indicates.

Returns:

obj - Object - An Object of type entry

getLogLength

public int getLogLength()

This method returns the number of logged objects in the log instance.

Returns:

length - int - number of entries in Log

getLogtype

public java.lang.String getLogtype()

This method returns the log type of the log class that implements this log interface.

Returns:

logtype - String - log type of the log