KickJava   Java API By Example, From Geeks To Geeks.

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


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  * The FixedSizeBuffer is a <strong>very</strong> efficient implementation of
54  * Buffer that does not alter the size of the buffer at runtime.
55  *
56  * @deprecated use org.apache.commons.collections.BoundedFifoBuffer instead
57  *
58  * @author <a HREF="mailto:bloritsch@apache.org">Berin Loritsch</a>
59  */

60 public final class FixedSizeBuffer implements Buffer
61 {
62     private final Object JavaDoc[] m_elements;
63     private int m_start = 0;
64     private int m_end = 0;
65     private boolean m_full = false;
66
67     public FixedSizeBuffer( int size )
68     {
69         m_elements = new Object JavaDoc[ size ];
70     }
71
72     public FixedSizeBuffer()
73     {
74         this( 32 );
75     }
76
77     public final int size()
78     {
79         int size = 0;
80
81         if( m_end < m_start )
82         {
83             size = m_elements.length - m_start + m_end;
84         }
85         else if( m_end == m_start )
86         {
87             size = ( m_full ? m_elements.length : 0 );
88         }
89         else
90         {
91             size = m_end - m_start;
92         }
93
94         return size;
95     }
96
97     public final boolean isEmpty()
98     {
99         return size() == 0;
100     }
101
102     public final void add( Object JavaDoc element )
103     {
104         if( null == element )
105         {
106             throw new NullPointerException JavaDoc( "Attempted to add null object to buffer" );
107         }
108
109         if( m_full )
110         {
111             throw new BufferOverflowException( "The buffer cannot hold more than "
112                                                + m_elements.length + " objects." );
113         }
114
115         m_elements[ m_end++ ] = element;
116
117         if( m_end >= m_elements.length )
118         {
119             m_end = 0;
120         }
121
122         if( m_end == m_start )
123         {
124             m_full = true;
125         }
126     }
127
128     public final Object JavaDoc remove()
129     {
130         if( isEmpty() )
131         {
132             throw new BufferUnderflowException( "The buffer is already empty" );
133         }
134
135         Object JavaDoc element = m_elements[ m_start ];
136
137         if( null != element )
138         {
139             m_elements[ m_start++ ] = null;
140
141             if( m_start >= m_elements.length )
142             {
143                 m_start = 0;
144             }
145
146             m_full = false;
147         }
148
149         return element;
150     }
151 }
152
Popular Tags