Java Doc for UnboundedFifoBuffer.java in  » Library » Apache-common-Collections » org » apache » commons » collections » buffer » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Library » Apache common Collections » org.apache.commons.collections.buffer 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.util.AbstractCollection
      org.apache.commons.collections.buffer.UnboundedFifoBuffer

UnboundedFifoBuffer
public class UnboundedFifoBuffer extends AbstractCollection implements Buffer,Serializable(Code)
UnboundedFifoBuffer is a very efficient implementation of Buffer that can grow to any size. According to performance testing, it exhibits a constant access time, but it also outperforms ArrayList when used for the same purpose.

The removal order of an UnboundedFifoBuffer is based on the insertion order; elements are removed in the same order in which they were added. The iteration order is the same as the removal order.

The UnboundedFifoBuffer.remove() and UnboundedFifoBuffer.get() operations perform in constant time. The UnboundedFifoBuffer.add(Object) operation performs in amortized constant time. All other operations perform in linear time or worse.

Note that this implementation is not synchronized. The following can be used to provide synchronized access to your UnboundedFifoBuffer:

 Buffer fifo = BufferUtils.synchronizedBuffer(new UnboundedFifoBuffer());
 

This buffer prevents null objects from being added.

This class is Serializable from Commons Collections 3.1.
since:
   Commons Collections 3.0 (previously in main package v2.1)
version:
   $Revision: 405927 $ $Date: 2006-05-12 23:57:03 +0100 (Fri, 12 May 2006) $
author:
   Avalon
author:
   Federico Barbieri
author:
   Berin Loritsch
author:
   Paul Jack
author:
   Stephen Colebourne
author:
   Andreas Schlosser
author:
   Thomas Knych
author:
   Jordan Krey



Field Summary
protected transient  Object[]buffer
     The array of objects in the buffer.
protected transient  inthead
     The current head index.
protected transient  inttail
     The current tail index.

Constructor Summary
public  UnboundedFifoBuffer()
     Constructs an UnboundedFifoBuffer with the default number of elements.
public  UnboundedFifoBuffer(int initialSize)
     Constructs an UnboundedFifoBuffer with the specified number of elements.

Method Summary
public  booleanadd(Object obj)
     Adds the given element to this buffer.
public  Objectget()
     Returns the next object in the buffer.
public  booleanisEmpty()
     Returns true if this buffer is empty; false otherwise.
public  Iteratoriterator()
     Returns an iterator over this buffer's elements.
public  Objectremove()
    
public  intsize()
     Returns the number of elements stored in the buffer.

Field Detail
buffer
protected transient Object[] buffer(Code)
The array of objects in the buffer.



head
protected transient int head(Code)
The current head index.



tail
protected transient int tail(Code)
The current tail index.




Constructor Detail
UnboundedFifoBuffer
public UnboundedFifoBuffer()(Code)
Constructs an UnboundedFifoBuffer with the default number of elements. It is exactly the same as performing the following:
 new UnboundedFifoBuffer(32);
 



UnboundedFifoBuffer
public UnboundedFifoBuffer(int initialSize)(Code)
Constructs an UnboundedFifoBuffer with the specified number of elements. The integer must be a positive integer.
Parameters:
  initialSize - the initial size of the buffer
throws:
  IllegalArgumentException - if the size is less than 1




Method Detail
add
public boolean add(Object obj)(Code)
Adds the given element to this buffer.
Parameters:
  obj - the element to add true, always
throws:
  NullPointerException - if the given element is null



get
public Object get()(Code)
Returns the next object in the buffer. the next object in the buffer
throws:
  BufferUnderflowException - if this buffer is empty



isEmpty
public boolean isEmpty()(Code)
Returns true if this buffer is empty; false otherwise. true if this buffer is empty



iterator
public Iterator iterator()(Code)
Returns an iterator over this buffer's elements. an iterator over this buffer's elements



remove
public Object remove()(Code)
Removes the next object from the buffer the removed object
throws:
  BufferUnderflowException - if this buffer is empty



size
public int size()(Code)
Returns the number of elements stored in the buffer. this buffer's size



Methods inherited from java.util.AbstractCollection
public boolean add(E e)(Code)(Java Doc)
public boolean addAll(Collection<? extends E> c)(Code)(Java Doc)
public void clear()(Code)(Java Doc)
public boolean contains(Object o)(Code)(Java Doc)
public boolean containsAll(Collection c)(Code)(Java Doc)
public boolean isEmpty()(Code)(Java Doc)
abstract public Iterator<E> iterator()(Code)(Java Doc)
public boolean remove(Object o)(Code)(Java Doc)
public boolean removeAll(Collection c)(Code)(Java Doc)
public boolean retainAll(Collection c)(Code)(Java Doc)
abstract public int size()(Code)(Java Doc)
public Object[] toArray()(Code)(Java Doc)
public T[] toArray(T[] a)(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.