commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scolebou...@apache.org
Subject cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections UnboundedFifoBuffer.java
Date Tue, 14 Oct 2003 18:05:42 GMT
scolebourne    2003/10/14 11:05:42

  Modified:    collections/src/java/org/apache/commons/collections
                        UnboundedFifoBuffer.java
  Log:
  Tidy code and Javadoc
  
  Revision  Changes    Path
  1.10      +16 -13    jakarta-commons/collections/src/java/org/apache/commons/collections/UnboundedFifoBuffer.java
  
  Index: UnboundedFifoBuffer.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/UnboundedFifoBuffer.java,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- UnboundedFifoBuffer.java	9 Oct 2003 20:58:53 -0000	1.9
  +++ UnboundedFifoBuffer.java	14 Oct 2003 18:05:42 -0000	1.10
  @@ -75,9 +75,9 @@
    * other operations perform in linear time or worse.
    * <p>
    * Note that this implementation is not synchronized.  The following can be
  - * used to provide synchronized access to your <code>UnboundedFifo</code>:
  + * used to provide synchronized access to your <code>UnboundedFifoBuffer</code>:
    * <pre>
  - *   Buffer fifo = BufferUtils.synchronizedBuffer(new UnboundedFifo());
  + *   Buffer fifo = BufferUtils.synchronizedBuffer(new UnboundedFifoBuffer());
    * </pre>
    * <p>
    * This buffer prevents null objects from being added.
  @@ -113,13 +113,14 @@
        * Constructs an UnboundedFifoBuffer with the specified number of elements.
        * The integer must be a positive integer.
        * 
  +     * @param initialSize  the initial size of the buffer
        * @throws IllegalArgumentException  if the size is less than 1
        */
  -    public UnboundedFifoBuffer(int size) {
  -        if (size <= 0) {
  +    public UnboundedFifoBuffer(int initialSize) {
  +        if (initialSize <= 0) {
               throw new IllegalArgumentException("The size must be greater than 0");
           }
  -        m_buffer = new Object[size + 1];
  +        m_buffer = new Object[initialSize + 1];
           m_head = 0;
           m_tail = 0;
       }
  @@ -153,13 +154,13 @@
       /**
        * Adds the given element to this buffer.
        *
  -     * @param o  the element to add
  +     * @param obj  the element to add
        * @return true, always
        * @throws NullPointerException  if the given element is null
        * @throws BufferOverflowException  if this buffer is full
        */
  -    public boolean add(final Object o) {
  -        if (null == o) {
  +    public boolean add(final Object obj) {
  +        if (obj == null) {
               throw new NullPointerException("Attempted to add null object to buffer");
           }
   
  @@ -183,7 +184,7 @@
               m_tail = j;
           }
   
  -        m_buffer[m_tail] = o;
  +        m_buffer[m_tail] = obj;
           m_tail++;
           if (m_tail >= m_buffer.length) {
               m_tail = 0;
  @@ -238,8 +239,9 @@
        */
       private int increment(int index) {
           index++;
  -        if (index >= m_buffer.length)
  +        if (index >= m_buffer.length) {
               index = 0;
  +        }
           return index;
       }
   
  @@ -251,8 +253,9 @@
        */
       private int decrement(int index) {
           index--;
  -        if (index < 0)
  +        if (index < 0) {
               index = m_buffer.length - 1;
  +        }
           return index;
       }
   
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message