Java Doc for BoundedFifoBuffer.java in  » Library » Apache-common-Collections » org » apache » commons » collections » 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 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.util.AbstractCollection
      org.apache.commons.collections.BoundedFifoBuffer

BoundedFifoBuffer
public class BoundedFifoBuffer extends AbstractCollection implements Buffer,BoundedCollection(Code)
The BoundedFifoBuffer is a very efficient implementation of Buffer that does not alter the size of the buffer at runtime.

The removal order of a BoundedFifoBuffer 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 BoundedFifoBuffer.add(Object) , BoundedFifoBuffer.remove() and BoundedFifoBuffer.get() operations all perform in 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 BoundedFifoBuffer:

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

This buffer prevents null objects from being added.
since:
   2.1
version:
   $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
author:
   Avalon
author:
   Berin Loritsch
author:
   Paul Jack
author:
   Stephen Colebourne
author:
   Herve Quiroz




Constructor Summary
public  BoundedFifoBuffer()
     Constructs a new BoundedFifoBuffer big enough to hold 32 elements.
public  BoundedFifoBuffer(int size)
     Constructs a new BoundedFifoBuffer big enough to hold the specified number of elements.
public  BoundedFifoBuffer(Collection coll)
     Constructs a new BoundedFifoBuffer big enough to hold all of the elements in the specified collection.

Method Summary
public  booleanadd(Object element)
     Adds the given element to this buffer.
public  voidclear()
     Clears this buffer.
public  Objectget()
     Returns the least recently inserted element in this buffer.
public  booleanisEmpty()
     Returns true if this buffer is empty; false otherwise.
public  booleanisFull()
     Returns true if this collection is full and no new elements can be added.
public  Iteratoriterator()
     Returns an iterator over this buffer's elements.
public  intmaxSize()
     Gets the maximum size of the collection (the bound).
public  Objectremove()
     Removes the least recently inserted element from this buffer.
public  intsize()
     Returns the number of elements stored in the buffer.


Constructor Detail
BoundedFifoBuffer
public BoundedFifoBuffer()(Code)
Constructs a new BoundedFifoBuffer big enough to hold 32 elements.



BoundedFifoBuffer
public BoundedFifoBuffer(int size)(Code)
Constructs a new BoundedFifoBuffer big enough to hold the specified number of elements.
Parameters:
  size - the maximum number of elements for this fifo
throws:
  IllegalArgumentException - if the size is less than 1



BoundedFifoBuffer
public BoundedFifoBuffer(Collection coll)(Code)
Constructs a new BoundedFifoBuffer big enough to hold all of the elements in the specified collection. That collection's elements will also be added to the buffer.
Parameters:
  coll - the collection whose elements to add, may not be null
throws:
  NullPointerException - if the collection is null




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



clear
public void clear()(Code)
Clears this buffer.



get
public Object get()(Code)
Returns the least recently inserted element in this buffer. the least recently inserted element
throws:
  BufferUnderflowException - if the buffer is empty



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



isFull
public boolean isFull()(Code)
Returns true if this collection is full and no new elements can be added. true if the collection is full



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



maxSize
public int maxSize()(Code)
Gets the maximum size of the collection (the bound). the maximum number of elements the collection can hold



remove
public Object remove()(Code)
Removes the least recently inserted element from this buffer. the least recently inserted element
throws:
  BufferUnderflowException - if the 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.