Package org.apache.log4j.helpers
Class CyclicBuffer
java.lang.Object
org.apache.log4j.helpers.CyclicBuffer
CyclicBuffer is used by other appenders to hold
LoggingEvents for immediate or differed
display.
This buffer gives read access to any element in the buffer not just the first or last element.
- Since:
- 0.9.0
- Author:
- Ceki Gülcü
-
Constructor Summary
ConstructorsConstructorDescriptionCyclicBuffer(int maxSize) Instantiate a new CyclicBuffer of at mostmaxSizeevents. -
Method Summary
Modifier and TypeMethodDescriptionvoidadd(LoggingEvent event) Add aneventas the last event in the buffer.get()Get the oldest (first) element in the buffer.get(int i) Get the ith oldest event currently in the buffer.intintlength()Get the number of elements in the buffer.voidresize(int newSize) Resize the cyclic buffer tonewSize.
-
Constructor Details
-
CyclicBuffer
Instantiate a new CyclicBuffer of at mostmaxSizeevents.The
maxSizeargument must a positive integer.- Parameters:
maxSize- The maximum number of elements in the buffer.- Throws:
IllegalArgumentException
-
-
Method Details
-
add
Add aneventas the last event in the buffer. -
get
Get the ith oldest event currently in the buffer. If i is outside the range 0 to the number of elements currently in the buffer, thennullis returned. -
getMaxSize
public int getMaxSize() -
get
Get the oldest (first) element in the buffer. The oldest element is removed from the buffer. -
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 cyclic buffer tonewSize.- Throws:
IllegalArgumentException- ifnewSizeis negative.
-