Package org.apache.log4j.helpers
Class BoundedFIFO
- java.lang.Object
-
- org.apache.log4j.helpers.BoundedFIFO
-
public class BoundedFIFO extends Object
Bounded first-in-first-out buffer.- Since:
- version 0.9.1
-
-
Constructor Summary
Constructors Constructor Description BoundedFIFO(int maxSize)
Constructs a new instance with a maximum size passed as argument.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LoggingEvent
get()
Gets the first element in the buffer.int
getMaxSize()
Gets the maximum size of the buffer.boolean
isFull()
Returnstrue
if the buffer is full, that is, whether the number of elements in the buffer equals the buffer size.int
length()
Gets the number of elements in the buffer.void
put(LoggingEvent o)
Puts aLoggingEvent
in the buffer.void
resize(int newSize)
Resizes the buffer to a new size.boolean
wasEmpty()
Returnstrue
if there is just one element in the buffer.boolean
wasFull()
Returnstrue
if the number of elements in the buffer plus 1 equals the maximum buffer size, returnsfalse
otherwise.
-
-
-
Method Detail
-
get
public LoggingEvent get()
Gets the first element in the buffer. Returnsnull
if there are no elements in the buffer.
-
getMaxSize
public int getMaxSize()
Gets the maximum size of the buffer.
-
isFull
public boolean isFull()
Returnstrue
if the buffer is full, that is, whether the number of elements in the buffer equals the buffer size.
-
length
public int length()
Gets the number of elements in the buffer. This number is guaranteed to be in the range 0 tomaxSize
(inclusive).
-
put
public void put(LoggingEvent o)
Puts aLoggingEvent
in the buffer. If the buffer is full then the event is silently dropped. It is the caller's responsability to make sure that the buffer has free space.
-
resize
public void resize(int newSize)
Resizes the buffer to a new size. If the new size is smaller than the old size events might be lost.- Since:
- 1.1
-
wasEmpty
public boolean wasEmpty()
Returnstrue
if there is just one element in the buffer. In other words, if there were no elements before the lastput(org.apache.log4j.spi.LoggingEvent)
operation completed.
-
wasFull
public boolean wasFull()
Returnstrue
if the number of elements in the buffer plus 1 equals the maximum buffer size, returnsfalse
otherwise.
-
-