org.hippoecm.hst.logging
Interface LogEventBuffer

All Known Implementing Classes:

CircularFIFOLogEventBuffer

public interface LogEventBuffer

Defines a collection that allows log events to be stored and removed in some well-defined order.

Version:

$Id: LogEventBuffer.java 18162 2009-05-19 13:19:29Z wko $

Method Summary

boolean	add(LogEvent event) Adds the given log event to this buffer.
void	clear() Clears this buffer.
LogEvent	get() Returns the least recently inserted element in this buffer.
LogEvent.Level	getLevel() Returns log level
String	getLevelName() Returns log level name
boolean	isEmpty() Returns true if this buffer is empty; false otherwise.
boolean	isFull() Returns true if this collection is full and no new elements can be added.
Iterator<LogEvent>	iterator() Returns an iterator over this buffer's elements.
int	maxSize() Gets the maximum size of the collection (the bound).
LogEvent	remove() Removes the least recently inserted element from this buffer.
void	setLevel(LogEvent.Level level) Sets log level to store.
void	setLevelByName(String levelName) Sets log level by its name to store.
int	size() Returns the number of elements stored in the buffer.

Method Detail

add

boolean add(LogEvent event)

Adds the given log event to this buffer.

Parameters:

event -

Returns:

clear

void clear()

Clears this buffer.

get

LogEvent get()

Returns the least recently inserted element in this buffer.

Returns:

isEmpty

boolean isEmpty()

Returns true if this buffer is empty; false otherwise.

Returns:

isFull

boolean isFull()

Returns true if this collection is full and no new elements can be added.

Returns:

iterator

Iterator<LogEvent> iterator()

Returns an iterator over this buffer's elements.

Returns:

maxSize

int maxSize()

Gets the maximum size of the collection (the bound).

Returns:

remove

LogEvent remove()

Removes the least recently inserted element from this buffer.

Returns:

size

int size()

Returns the number of elements stored in the buffer.

Returns:

setLevel

void setLevel(LogEvent.Level level)

Sets log level to store.

Parameters:

level -

setLevelByName

void setLevelByName(String levelName)

Sets log level by its name to store.

Parameters:

level -

getLevel

LogEvent.Level getLevel()

Returns log level

Returns:

getLevelName

String getLevelName()

Returns log level name

Returns: