KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > excalibur > collections > CircularBuffer


1 /*
2
3  ============================================================================
4                    The Apache Software License, Version 1.1
5  ============================================================================
6  
7  Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  
9  Redistribution and use in source and binary forms, with or without modifica-
10  tion, are permitted provided that the following conditions are met:
11  
12  1. Redistributions of source code must retain the above copyright notice,
13     this list of conditions and the following disclaimer.
14  
15  2. Redistributions in binary form must reproduce the above copyright notice,
16     this list of conditions and the following disclaimer in the documentation
17     and/or other materials provided with the distribution.
18  
19  3. The end-user documentation included with the redistribution, if any, must
20     include the following acknowledgment: "This product includes software
21     developed by the Apache Software Foundation (http://www.apache.org/)."
22     Alternately, this acknowledgment may appear in the software itself, if
23     and wherever such third-party acknowledgments normally appear.
24  
25  4. The names "Jakarta", "Avalon", "Excalibur" and "Apache Software Foundation"
26     must not be used to endorse or promote products derived from this software
27     without prior written permission. For written permission, please contact
28     apache@apache.org.
29  
30  5. Products derived from this software may not be called "Apache", nor may
31     "Apache" appear in their name, without prior written permission of the
32     Apache Software Foundation.
33  
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45  This software consists of voluntary contributions made by many individuals
46  on behalf of the Apache Software Foundation. For more information on the
47  Apache Software Foundation, please see <http://www.apache.org/>.
48  
49 */

50 package org.apache.avalon.excalibur.collections;
51
52 /**
53  * @deprecated use one of the Buffer implementations instead.
54  *
55  * @author Federico Barbieri <fede@apache.org>
56  * @version CVS $Revision: 1.4 $ $Date: 2003/03/22 12:46:22 $
57  * @since 4.0
58  */

59 public class CircularBuffer
60 {
61     protected Object JavaDoc[] m_buffer;
62     protected int m_bufferSize;
63     protected int m_contentSize;
64     protected int m_head;
65     protected int m_tail;
66
67     public CircularBuffer( int size )
68     {
69         m_buffer = new Object JavaDoc[ size ];
70         m_bufferSize = size;
71         m_contentSize = 0;
72         m_head = 0;
73         m_tail = 0;
74     }
75
76     public CircularBuffer()
77     {
78         this( 32 );
79     }
80
81     public boolean isEmpty()
82     {
83         return ( m_contentSize == 0 );
84     }
85
86     public int getContentSize()
87     {
88         return m_contentSize;
89     }
90
91     public int getBufferSize()
92     {
93         return m_bufferSize;
94     }
95
96     public void append( final Object JavaDoc o )
97     {
98         if( m_contentSize >= m_bufferSize )
99         {
100             int j = 0;
101             int i = m_tail;
102             Object JavaDoc[] tmp = new Object JavaDoc[ m_bufferSize * 2 ];
103
104             while( m_contentSize > 0 )
105             {
106                 i++;
107                 i %= m_bufferSize;
108                 j++;
109                 m_contentSize--;
110                 tmp[ j ] = m_buffer[ i ];
111             }
112             m_buffer = tmp;
113             m_tail = 0;
114             m_head = j;
115             m_contentSize = j;
116             m_bufferSize *= 2;
117         }
118
119         m_buffer[ m_head ] = o;
120         m_head++;
121         m_head %= m_bufferSize;
122         m_contentSize++;
123     }
124
125     public Object JavaDoc get()
126     {
127         if( m_contentSize <= 0 )
128         {
129             return null;
130         }
131
132         Object JavaDoc o = m_buffer[ m_tail ];
133         m_tail++;
134         m_tail %= m_bufferSize;
135         m_contentSize--;
136         return o;
137     }
138 }
139
140
Popular Tags