com.SecurePlay.SPLcircularLog
Class SPLCircularLogClass

java.lang.Object
  com.SecurePlay.SPLcircularLog.SPLCircularLogClass

All Implemented Interfaces:

SPLogInterface

public class SPLCircularLogClass

extends java.lang.Object

implements SPLogInterface

This is a circular log to hold a limited number of messages. The log will then roll over.

Author:

ITGlobalSecure

See Also:

SecurePlay License Information

Field Summary

private int	currview This is an integer value representing the current entry in the log for viewing
private int	loglength This is an integer value that is the length of the log
private java.lang.String	logtype
private java.util.Vector	prentryList This is a private object that acts as the storage container for the log object entries.
private int	prptr This is a pointer to indicate the current location in an existing log object.
(package private) java.lang.String	releaseversion IT GlobalSecure release version.

Constructor Summary

SPLCircularLogClass(int ilogsize)
Alternate Constructor.

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.
void	setLogLength(int logsize) Sets the log length.

Methods inherited from class java.lang.Object

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

Field Detail

prentryList

private java.util.Vector prentryList

This is a private object that acts as the storage container for the log object entries.

prptr

private int prptr

This is a pointer to indicate the current location in an existing log object.

loglength

private int loglength

This is an integer value that is the length of the log

currview

private int currview

This is an integer value representing the current entry in the log for viewing

releaseversion

final java.lang.String releaseversion

IT GlobalSecure release version.

See Also:

Constant Field Values

logtype

private java.lang.String logtype

Constructor Detail

SPLCircularLogClass

public SPLCircularLogClass(int ilogsize)

Alternate Constructor. Constructs a new SPCircularLogClass() with log size set

Method Detail

addEntry

public void addEntry(java.lang.Object entry)

Add a entry to the log object.

Specified by:

addEntry in interface SPLogInterface

Parameters:

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

clear

public void clear()

Clear the log.

Specified by:

clear in interface SPLogInterface

reset

public boolean reset()

Resets the log pointer.

Specified by:

reset in interface SPLogInterface

Returns:

result - Boolean: TRUE, to confirm the reset.

getNextEntry

public java.lang.Object getNextEntry()

Get the next entry in the log.

Specified by:

getNextEntry in interface SPLogInterface

Returns:

obj - Object - An entry object

getPreviousEntry

public java.lang.Object getPreviousEntry()

This method returns the previous entry in the log.

Specified by:

getPreviousEntry in interface SPLogInterface

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.

Specified by:

getCurrentEntry in interface SPLogInterface

Returns:

obj - Object - An Object of type entry

getLogLength

public int getLogLength()

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

Specified by:

getLogLength in interface SPLogInterface

Returns:

length - int - number of entries in Log

setLogLength

public void setLogLength(int logsize)

Sets the log length.

Parameters:

logsize - int - log length

getLogtype

public java.lang.String getLogtype()

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

Specified by:

getLogtype in interface SPLogInterface

Returns:

logtype - String - log type of the log