/lib/apache-log4j/site/apidocs/org/apache/log4j/helpers/BoundedFIFO.html

https://bitbucket.org/arkban/somersault · HTML · 432 lines · 365 code · 45 blank · 22 comment · 0 complexity · 3f3f8687768766ef1a2bf68162a1a290 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.6.0_16) -->
    6. 

  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    7. 

  7. <TITLE>
    8. 

  8. BoundedFIFO (Apache Log4j 1.2.16 API)
    9. 

  9. </TITLE>
    10. 

  10. 

  11. <META NAME="date" CONTENT="2010-03-30">
    12. 

  12. 

  13. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
    14. 

  14. 

  15. <SCRIPT type="text/javascript">
    16. 

  16. function windowTitle()
    17. 

  17. {
    18. 

  18.     if (location.href.indexOf('is-external=true') == -1) {
    19. 

  19.         parent.document.title="BoundedFIFO (Apache Log4j 1.2.16 API)";
    20. 

  20.     }
    21. 

  21. }
    22. 

  22. </SCRIPT>
    23. 

  23. <NOSCRIPT>
    24. 

  24. </NOSCRIPT>
    25. 

  25. 

  26. </HEAD>
    27. 

  27. 

  28. <BODY BGCOLOR="white" onload="windowTitle();">
    29. 

  29. <HR>
    30. 

  30. 

  31. 

  32. <!-- ========= START OF TOP NAVBAR ======= -->
    33. 

  33. <A NAME="navbar_top"><!-- --></A>
    34. 

  34. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    35. 

  35. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    36. 

  36. <TR>
    37. 

  37. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    38. 

  38. <A NAME="navbar_top_firstrow"><!-- --></A>
    39. 

  39. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    40. 

  40.   <TR ALIGN="center" VALIGN="top">
    41. 

  41.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    42. 

  42.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    43. 

  43.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    44. 

  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BoundedFIFO.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    45. 

  45.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    46. 

  46.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    47. 

  47.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    48. 

  48.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    49. 

  49.   </TR>
    50. 

  50. </TABLE>
    51. 

  51. </TD>
    52. 

  52. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    53. 

  53. </EM>
    54. 

  54. </TD>
    55. 

  55. </TR>
    56. 

  56. 

  57. <TR>
    58. 

  58. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    59. 

  59. &nbsp;<A HREF="../../../../org/apache/log4j/helpers/AppenderAttachableImpl.html" title="class in org.apache.log4j.helpers"><B>PREV CLASS</B></A>&nbsp;
    60. 

  60. &nbsp;<A HREF="../../../../org/apache/log4j/helpers/CountingQuietWriter.html" title="class in org.apache.log4j.helpers"><B>NEXT CLASS</B></A></FONT></TD>
    61. 

  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    62. 

  62.   <A HREF="../../../../index.html?org/apache/log4j/helpers/BoundedFIFO.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    63. 

  63. &nbsp;<A HREF="BoundedFIFO.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    64. 

  64. &nbsp;<SCRIPT type="text/javascript">
    65. 

  65.   <!--
    66. 

  66.   if(window==top) {
    67. 

  67.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    68. 

  68.   }
    69. 

  69.   //-->
    70. 

  70. </SCRIPT>
    71. 

  71. <NOSCRIPT>
    72. 

  72.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    73. 

  73. </NOSCRIPT>
    74. 

  74. 

  75. 

  76. </FONT></TD>
    77. 

  77. </TR>
    78. 

  78. <TR>
    79. 

  79. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    80. 

  80.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    81. 

  81. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    82. 

  82. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    83. 

  83. </TR>
    84. 

  84. </TABLE>
    85. 

  85. <A NAME="skip-navbar_top"></A>
    86. 

  86. <!-- ========= END OF TOP NAVBAR ========= -->
    87. 

  87. 

  88. <HR>
    89. 

  89. <!-- ======== START OF CLASS DATA ======== -->
    90. 

  90. <H2>
    91. 

  91. <FONT SIZE="-1">
    92. 

  92. org.apache.log4j.helpers</FONT>
    93. 

  93. <BR>
    94. 

  94. Class BoundedFIFO</H2>
    95. 

  95. <PRE>
    96. 

  96. <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
    97. 

  97.   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.log4j.helpers.BoundedFIFO</B>
    98. 

  98. </PRE>
    99. 

  99. <HR>
    100. 

  100. <DL>
    101. 

  101. <DT><PRE>public class <B>BoundedFIFO</B><DT>extends <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
    102. 

  102. </PRE>
    103. 

  103. 

  104. <P>
    105. 

  105. <code>BoundedFIFO</code> serves as the bounded first-in-first-out
    106. 

  106.    buffer heavily used by the <A HREF="../../../../org/apache/log4j/AsyncAppender.html" title="class in org.apache.log4j"><CODE>AsyncAppender</CODE></A>.
    107. 

  107. <P>
    108. 

  108. 

  109. <P>
    110. 

  110. <DL>
    111. 

  111. <DT><B>Since:</B></DT>
    112. 

  112.   <DD>version 0.9.1</DD>
    113. 

  113. <DT><B>Author:</B></DT>
    114. 

  114.   <DD>Ceki G&uuml;lc&uuml;</DD>
    115. 

  115. </DL>
    116. 

  116. <HR>
    117. 

  117. 

  118. <P>
    119. 

  119. 

  120. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    121. 

  121. 

  122. <A NAME="constructor_summary"><!-- --></A>
    123. 

  123. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    124. 

  124. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    125. 

  125. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    126. 

  126. <B>Constructor Summary</B></FONT></TH>
    127. 

  127. </TR>
    128. 

  128. <TR BGCOLOR="white" CLASS="TableRowColor">
    129. 

  129. <TD><CODE><B><A HREF="../../../../org/apache/log4j/helpers/BoundedFIFO.html#BoundedFIFO(int)">BoundedFIFO</A></B>(int&nbsp;maxSize)</CODE>
    130. 

  130. 

  131. <BR>
    132. 

  132. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Instantiate a new BoundedFIFO with a maximum size passed as argument.</TD>
    133. 

  133. </TR>
    134. 

  134. </TABLE>
    135. 

  135. &nbsp;
    136. 

  136. <!-- ========== METHOD SUMMARY =========== -->
    137. 

  137. 

  138. <A NAME="method_summary"><!-- --></A>
    139. 

  139. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    140. 

  140. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    141. 

  141. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    142. 

  142. <B>Method Summary</B></FONT></TH>
    143. 

  143. </TR>
    144. 

  144. <TR BGCOLOR="white" CLASS="TableRowColor">
    145. 

  145. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    146. 

  146. <CODE>&nbsp;<A HREF="../../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</A></CODE></FONT></TD>
    147. 

  147. <TD><CODE><B><A HREF="../../../../org/apache/log4j/helpers/BoundedFIFO.html#get()">get</A></B>()</CODE>
    148. 

  148. 

  149. <BR>
    150. 

  150. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the first element in the buffer.</TD>
    151. 

  151. </TR>
    152. 

  152. <TR BGCOLOR="white" CLASS="TableRowColor">
    153. 

  153. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    154. 

  154. <CODE>&nbsp;int</CODE></FONT></TD>
    155. 

  155. <TD><CODE><B><A HREF="../../../../org/apache/log4j/helpers/BoundedFIFO.html#getMaxSize()">getMaxSize</A></B>()</CODE>
    156. 

  156. 

  157. <BR>
    158. 

  158. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the maximum size of the buffer.</TD>
    159. 

  159. </TR>
    160. 

  160. <TR BGCOLOR="white" CLASS="TableRowColor">
    161. 

  161. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    162. 

  162. <CODE>&nbsp;boolean</CODE></FONT></TD>
    163. 

  163. <TD><CODE><B><A HREF="../../../../org/apache/log4j/helpers/BoundedFIFO.html#isFull()">isFull</A></B>()</CODE>
    164. 

  164. 

  165. <BR>
    166. 

  166. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return <code>true</code> if the buffer is full, that is, whether
    167. 

  167.      the number of elements in the buffer equals the buffer size.</TD>
    168. 

  168. </TR>
    169. 

  169. <TR BGCOLOR="white" CLASS="TableRowColor">
    170. 

  170. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    171. 

  171. <CODE>&nbsp;int</CODE></FONT></TD>
    172. 

  172. <TD><CODE><B><A HREF="../../../../org/apache/log4j/helpers/BoundedFIFO.html#length()">length</A></B>()</CODE>
    173. 

  173. 

  174. <BR>
    175. 

  175. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the number of elements in the buffer.</TD>
    176. 

  176. </TR>
    177. 

  177. <TR BGCOLOR="white" CLASS="TableRowColor">
    178. 

  178. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    179. 

  179. <CODE>&nbsp;void</CODE></FONT></TD>
    180. 

  180. <TD><CODE><B><A HREF="../../../../org/apache/log4j/helpers/BoundedFIFO.html#put(org.apache.log4j.spi.LoggingEvent)">put</A></B>(<A HREF="../../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</A>&nbsp;o)</CODE>
    181. 

  181. 

  182. <BR>
    183. 

  183. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Place a <A HREF="../../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi"><CODE>LoggingEvent</CODE></A> in the buffer.</TD>
    184. 

  184. </TR>
    185. 

  185. <TR BGCOLOR="white" CLASS="TableRowColor">
    186. 

  186. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    187. 

  187. <CODE>&nbsp;void</CODE></FONT></TD>
    188. 

  188. <TD><CODE><B><A HREF="../../../../org/apache/log4j/helpers/BoundedFIFO.html#resize(int)">resize</A></B>(int&nbsp;newSize)</CODE>
    189. 

  189. 

  190. <BR>
    191. 

  191. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resize the buffer to a new size.</TD>
    192. 

  192. </TR>
    193. 

  193. <TR BGCOLOR="white" CLASS="TableRowColor">
    194. 

  194. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    195. 

  195. <CODE>&nbsp;boolean</CODE></FONT></TD>
    196. 

  196. <TD><CODE><B><A HREF="../../../../org/apache/log4j/helpers/BoundedFIFO.html#wasEmpty()">wasEmpty</A></B>()</CODE>
    197. 

  197. 

  198. <BR>
    199. 

  199. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if there is just one element in the
    200. 

  200.      buffer.</TD>
    201. 

  201. </TR>
    202. 

  202. <TR BGCOLOR="white" CLASS="TableRowColor">
    203. 

  203. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    204. 

  204. <CODE>&nbsp;boolean</CODE></FONT></TD>
    205. 

  205. <TD><CODE><B><A HREF="../../../../org/apache/log4j/helpers/BoundedFIFO.html#wasFull()">wasFull</A></B>()</CODE>
    206. 

  206. 

  207. <BR>
    208. 

  208. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the number of elements in the
    209. 

  209.       buffer plus 1 equals the maximum buffer size, returns
    210. 

  210.       <code>false</code> otherwise.</TD>
    211. 

  211. </TR>
    212. 

  212. </TABLE>
    213. 

  213. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
    214. 

  214. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    215. 

  215. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    216. 

  216. <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
    217. 

  217. </TR>
    218. 

  218. <TR BGCOLOR="white" CLASS="TableRowColor">
    219. 

  219. <TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
    220. 

  220. </TR>
    221. 

  221. </TABLE>
    222. 

  222. &nbsp;
    223. 

  223. <P>
    224. 

  224. 

  225. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    226. 

  226. 

  227. <A NAME="constructor_detail"><!-- --></A>
    228. 

  228. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    229. 

  229. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    230. 

  230. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    231. 

  231. <B>Constructor Detail</B></FONT></TH>
    232. 

  232. </TR>
    233. 

  233. </TABLE>
    234. 

  234. 

  235. <A NAME="BoundedFIFO(int)"><!-- --></A><H3>
    236. 

  236. BoundedFIFO</H3>
    237. 

  237. <PRE>
    238. 

  238. public <B>BoundedFIFO</B>(int&nbsp;maxSize)</PRE>
    239. 

  239. <DL>
    240. 

  240. <DD>Instantiate a new BoundedFIFO with a maximum size passed as argument.
    241. 

  241. <P>
    242. 

  242. </DL>
    243. 

  243. 

  244. <!-- ============ METHOD DETAIL ========== -->
    245. 

  245. 

  246. <A NAME="method_detail"><!-- --></A>
    247. 

  247. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    248. 

  248. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    249. 

  249. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    250. 

  250. <B>Method Detail</B></FONT></TH>
    251. 

  251. </TR>
    252. 

  252. </TABLE>
    253. 

  253. 

  254. <A NAME="get()"><!-- --></A><H3>
    255. 

  255. get</H3>
    256. 

  256. <PRE>
    257. 

  257. public <A HREF="../../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</A> <B>get</B>()</PRE>
    258. 

  258. <DL>
    259. 

  259. <DD>Get the first element in the buffer. Returns <code>null</code> if
    260. 

  260.      there are no elements in the buffer.
    261. 

  261. <P>
    262. 

  262. <DD><DL>
    263. 

  263. </DL>
    264. 

  264. </DD>
    265. 

  265. </DL>
    266. 

  266. <HR>
    267. 

  267. 

  268. <A NAME="put(org.apache.log4j.spi.LoggingEvent)"><!-- --></A><H3>
    269. 

  269. put</H3>
    270. 

  270. <PRE>
    271. 

  271. public void <B>put</B>(<A HREF="../../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</A>&nbsp;o)</PRE>
    272. 

  272. <DL>
    273. 

  273. <DD>Place a <A HREF="../../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi"><CODE>LoggingEvent</CODE></A> in the buffer. If the buffer is full
    274. 

  274.      then the event is <b>silently dropped</b>. It is the caller's
    275. 

  275.      responsability to make sure that the buffer has free space.
    276. 

  276. <P>
    277. 

  277. <DD><DL>
    278. 

  278. </DL>
    279. 

  279. </DD>
    280. 

  280. </DL>
    281. 

  281. <HR>
    282. 

  282. 

  283. <A NAME="getMaxSize()"><!-- --></A><H3>
    284. 

  284. getMaxSize</H3>
    285. 

  285. <PRE>
    286. 

  286. public int <B>getMaxSize</B>()</PRE>
    287. 

  287. <DL>
    288. 

  288. <DD>Get the maximum size of the buffer.
    289. 

  289. <P>
    290. 

  290. <DD><DL>
    291. 

  291. </DL>
    292. 

  292. </DD>
    293. 

  293. </DL>
    294. 

  294. <HR>
    295. 

  295. 

  296. <A NAME="isFull()"><!-- --></A><H3>
    297. 

  297. isFull</H3>
    298. 

  298. <PRE>
    299. 

  299. public boolean <B>isFull</B>()</PRE>
    300. 

  300. <DL>
    301. 

  301. <DD>Return <code>true</code> if the buffer is full, that is, whether
    302. 

  302.      the number of elements in the buffer equals the buffer size.
    303. 

  303. <P>
    304. 

  304. <DD><DL>
    305. 

  305. </DL>
    306. 

  306. </DD>
    307. 

  307. </DL>
    308. 

  308. <HR>
    309. 

  309. 

  310. <A NAME="length()"><!-- --></A><H3>
    311. 

  311. length</H3>
    312. 

  312. <PRE>
    313. 

  313. public int <B>length</B>()</PRE>
    314. 

  314. <DL>
    315. 

  315. <DD>Get the number of elements in the buffer. This number is
    316. 

  316.      guaranteed to be in the range 0 to <code>maxSize</code>
    317. 

  317.      (inclusive).
    318. 

  318. <P>
    319. 

  319. <DD><DL>
    320. 

  320. </DL>
    321. 

  321. </DD>
    322. 

  322. </DL>
    323. 

  323. <HR>
    324. 

  324. 

  325. <A NAME="resize(int)"><!-- --></A><H3>
    326. 

  326. resize</H3>
    327. 

  327. <PRE>
    328. 

  328. public void <B>resize</B>(int&nbsp;newSize)</PRE>
    329. 

  329. <DL>
    330. 

  330. <DD>Resize the buffer to a new size. If the new size is smaller than
    331. 

  331.      the old size events might be lost.
    332. 

  332. <P>
    333. 

  333. <DD><DL>
    334. 

  334. <DT><B>Since:</B></DT>
    335. 

  335.   <DD>1.1</DD>
    336. 

  336. </DL>
    337. 

  337. </DD>
    338. 

  338. </DL>
    339. 

  339. <HR>
    340. 

  340. 

  341. <A NAME="wasEmpty()"><!-- --></A><H3>
    342. 

  342. wasEmpty</H3>
    343. 

  343. <PRE>
    344. 

  344. public boolean <B>wasEmpty</B>()</PRE>
    345. 

  345. <DL>
    346. 

  346. <DD>Returns <code>true</code> if there is just one element in the
    347. 

  347.      buffer. In other words, if there were no elements before the last
    348. 

  348.      <A HREF="../../../../org/apache/log4j/helpers/BoundedFIFO.html#put(org.apache.log4j.spi.LoggingEvent)"><CODE>put(org.apache.log4j.spi.LoggingEvent)</CODE></A> operation completed.
    349. 

  349. <P>
    350. 

  350. <DD><DL>
    351. 

  351. </DL>
    352. 

  352. </DD>
    353. 

  353. </DL>
    354. 

  354. <HR>
    355. 

  355. 

  356. <A NAME="wasFull()"><!-- --></A><H3>
    357. 

  357. wasFull</H3>
    358. 

  358. <PRE>
    359. 

  359. public boolean <B>wasFull</B>()</PRE>
    360. 

  360. <DL>
    361. 

  361. <DD>Returns <code>true</code> if the number of elements in the
    362. 

  362.       buffer plus 1 equals the maximum buffer size, returns
    363. 

  363.       <code>false</code> otherwise.
    364. 

  364. <P>
    365. 

  365. <DD><DL>
    366. 

  366. </DL>
    367. 

  367. </DD>
    368. 

  368. </DL>
    369. 

  369. <!-- ========= END OF CLASS DATA ========= -->
    370. 

  370. <HR>
    371. 

  371. 

  372. 

  373. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    374. 

  374. <A NAME="navbar_bottom"><!-- --></A>
    375. 

  375. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    376. 

  376. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    377. 

  377. <TR>
    378. 

  378. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    379. 

  379. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    380. 

  380. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    381. 

  381.   <TR ALIGN="center" VALIGN="top">
    382. 

  382.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    383. 

  383.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    384. 

  384.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    385. 

  385.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BoundedFIFO.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    386. 

  386.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    387. 

  387.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    388. 

  388.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    389. 

  389.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    390. 

  390.   </TR>
    391. 

  391. </TABLE>
    392. 

  392. </TD>
    393. 

  393. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    394. 

  394. </EM>
    395. 

  395. </TD>
    396. 

  396. </TR>
    397. 

  397. 

  398. <TR>
    399. 

  399. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    400. 

  400. &nbsp;<A HREF="../../../../org/apache/log4j/helpers/AppenderAttachableImpl.html" title="class in org.apache.log4j.helpers"><B>PREV CLASS</B></A>&nbsp;
    401. 

  401. &nbsp;<A HREF="../../../../org/apache/log4j/helpers/CountingQuietWriter.html" title="class in org.apache.log4j.helpers"><B>NEXT CLASS</B></A></FONT></TD>
    402. 

  402. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    403. 

  403.   <A HREF="../../../../index.html?org/apache/log4j/helpers/BoundedFIFO.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    404. 

  404. &nbsp;<A HREF="BoundedFIFO.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    405. 

  405. &nbsp;<SCRIPT type="text/javascript">
    406. 

  406.   <!--
    407. 

  407.   if(window==top) {
    408. 

  408.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    409. 

  409.   }
    410. 

  410.   //-->
    411. 

  411. </SCRIPT>
    412. 

  412. <NOSCRIPT>
    413. 

  413.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    414. 

  414. </NOSCRIPT>
    415. 

  415. 

  416. 

  417. </FONT></TD>
    418. 

  418. </TR>
    419. 

  419. <TR>
    420. 

  420. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    421. 

  421.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    422. 

  422. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    423. 

  423. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    424. 

  424. </TR>
    425. 

  425. </TABLE>
    426. 

  426. <A NAME="skip-navbar_bottom"></A>
    427. 

  427. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    428. 

  428. 

  429. <HR>
    430. 

  430. Copyright &#169; 1999-2010 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.
    431. 

  431. </BODY>
    432. 

  432. </HTML>
    433.