Package org.apache.log4j.helpers
Class BoundedFIFO
java.lang.Object
org.apache.log4j.helpers.BoundedFIFO
BoundedFIFO
serves as the bounded first-in-first-out buffer
heavily used by the AsyncAppender
.- Since:
- version 0.9.1
- Author:
- Ceki Gülcü
-
Constructor Summary
ConstructorsConstructorDescriptionBoundedFIFO
(int maxSize) Instantiate a new BoundedFIFO with a maximum size passed as argument. -
Method Summary
Modifier and TypeMethodDescriptionget()
Get the first element in the buffer.int
Get the maximum size of the buffer.boolean
isFull()
Returntrue
if the buffer is full, that is, whether the number of elements in the buffer equals the buffer size.int
length()
Get the number of elements in the buffer.void
put
(LoggingEvent o) Place aLoggingEvent
in the buffer.void
resize
(int newSize) Resize 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.
-
Constructor Details
-
BoundedFIFO
public BoundedFIFO(int maxSize) Instantiate a new BoundedFIFO with a maximum size passed as argument.
-
-
Method Details
-
get
Get the first element in the buffer. Returnsnull
if there are no elements in the buffer. -
put
Place 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. -
getMaxSize
public int getMaxSize()Get the maximum size of the buffer. -
isFull
public boolean isFull()Returntrue
if the buffer is full, that is, whether the number of elements in the buffer equals the buffer size. -
length
public int length()Get the number of elements in the buffer. This number is guaranteed to be in the range 0 tomaxSize
(inclusive). -
resize
public void resize(int newSize) Resize 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.
-