Poseidon for UMLTM
  UMLdoc
 PREV  CLASSIFIER    NEXT  CLASSIFIER     FRAMES    NO FRAMES      
SUMMARY:   INNER | ATTR | ASSOC | CONSTR | METHOD     DETAIL:   INNER | ATTR | ASSOC | CONSTR | METHOD     DIAGRAMS:   COLLAB | SEQ | STATE | ACTIV

com.gentleware.services.util

Class DebugArrayList

com.gentleware.services.util.DebugAbstractList
    inheritcom.gentleware.services.util.DebugArrayList

public class DebugArrayList


Resizable-array implementation of the List interface. Implements all optional list operations, and permits all elements, including null. In addition to implementing the List interface, this class provides methods to manipulate the size of the array that is used internally to store the list. (This class is roughly equivalent to Vector, except that it is unsynchronized.)

The size, isEmpty, get, set, iterator, and listIterator operations run in constant time. The add operation runs in amortized constant time, that is, adding n elements requires O(n) time. All of the other operations run in linear time (roughly speaking). The constant factor is low compared to that for the LinkedList implementation.

Each ArrayList instance has a capacity. The capacity is the size of the array used to store the elements in the list. It is always at least as large as the list size. As elements are added to an ArrayList, its capacity grows automatically. The details of the growth policy are not specified beyond the fact that adding an element has constant amortized time cost.

An application can increase the capacity of an ArrayList instance before adding a large number of elements using the ensureCapacity operation. This may reduce the amount of incremental reallocation.

Note that this implementation is not synchronized. If multiple threads access an ArrayList instance concurrently, and at least one of the threads modifies the list structurally, it must be synchronized externally. (A structural modification is any operation that adds or deletes one or more elements, or explicitly resizes the backing array; merely setting the value of an element is not a structural modification.) This is typically accomplished by synchronizing on some object that naturally encapsulates the list. If no such object exists, the list should be "wrapped" using the Collections.synchronizedList method. This is best done at creation time, to prevent accidental unsynchronized access to the list:

List list = Collections.synchronizedList(new ArrayList(...));

The iterators returned by this class's iterator and listIterator methods are fail-fast: if list is structurally modified at any time after the iterator is created, in any way except through the iterator's own remove or add methods, the iterator will throw a ConcurrentModificationException. Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.

Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect bugs.

This class is a member of the Java Collections Framework.

Version:
1.41, 01/23/03
Since:
1.2
See also:
java.util.Collections#synchronizedList(java.util.List)


 Attribute Summary
private Object[]  elementData
The array buffer into which the elements of the ArrayList are stored. 
private static long  serialVersionUID
 
private int  size
The size of the ArrayList (the number of elements it contains). 
arrow_up
 

 Constructor Summary
public   DebugArrayList(int initialCapacity)
Constructs an empty list with the specified initial capacity. 
public   DebugArrayList()
Constructs an empty list with an initial capacity of ten. 
public   DebugArrayList(Collection c)
Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator. 
arrow_up
 

 Method Summary
private void   RangeCheck(int index)
Check if the given index is in range. 
public boolean   add(Object o)
Appends the specified element to the end of this list. 
public void   add(int index, Object element)
Inserts the specified element at the specified position in this list. 
public boolean   addAll(Collection c)
Appends all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator. 
public boolean   addAll(int index, Collection c)
Inserts all of the elements in the specified Collection into this list, starting at the specified position. 
public void   clear()
Removes all of the elements from this list. 
public Object   clone()
Returns a shallow copy of this ArrayList instance. 
public boolean   contains(Object elem)
Returns true if this list contains the specified element. 
public void   ensureCapacity(int minCapacity)
Increases the capacity of this ArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument. 
public Object   get(int index)
Returns the element at the specified position in this list. 
public int   indexOf(Object elem)
Searches for the first occurence of the given argument, testing for equality using the equals method. 
public boolean   isEmpty()
Tests if this list has no elements. 
public int   lastIndexOf(Object elem)
Returns the index of the last occurrence of the specified object in this list. 
private void   readObject(ObjectInputStream s)
Reconstitute the ArrayList instance from a stream (that is, deserialize it). 
public Object   remove(int index)
Removes the element at the specified position in this list. 
protected void   removeRange(int fromIndex, int toIndex)
Removes from this List all of the elements whose index is between fromIndex, inclusive and toIndex, exclusive. 
public Object   set(int index, Object element)
Replaces the element at the specified position in this list with the specified element. 
public int   size()
Returns the number of elements in this list. 
public Object[]   toArray()
Returns an array containing all of the elements in this list in the correct order. 
public Object[]   toArray(Object[] a)
Returns an array containing all of the elements in this list in the correct order; the runtime type of the returned array is that of the specified array. 
public void   trimToSize()
Trims the capacity of this ArrayList instance to be the list's current size. 
private void   writeObject(ObjectOutputStream s)
Save the state of the ArrayList instance to a stream (that is, serialize it). 
arrow_up
 

Tagged Values
static false
gentleware-imported-line-number 72
gentleware-imported-package-statement-line-number 8
 

 Attribute Detail

elementData

private Object[] elementData

The array buffer into which the elements of the ArrayList are stored. The capacity of the ArrayList is the length of this array buffer.  
arrow_up


serialVersionUID

private static long serialVersionUID

arrow_up


size

private int size

The size of the ArrayList (the number of elements it contains).  
arrow_up
 Constructor Detail

DebugArrayList

public com.gentleware.services.util.DebugArrayList DebugArrayList(int initialCapacity)


Constructs an empty list with the specified initial capacity.  
Parameters:
initialCapacity - the initial capacity of the list.
Returns:
Exceptions:
IllegalArgumentException if the specified initial capacity is negative
arrow_up


DebugArrayList

public com.gentleware.services.util.DebugArrayList DebugArrayList()


Constructs an empty list with an initial capacity of ten.  
Returns:
arrow_up


DebugArrayList

public com.gentleware.services.util.DebugArrayList DebugArrayList(Collection c)


Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator. The ArrayList instance has an initial capacity of 110% the size of the specified collection.  
Parameters:
c - the collection whose elements are to be placed into this list.
Returns:
Exceptions:
NullPointerException if the specified collection is null.
arrow_up
 Method Detail

RangeCheck

private void RangeCheck(int index)


Check if the given index is in range. If not, throw an appropriate runtime exception. This method does *not* check if the index is negative: It is always used immediately prior to an array access, which throws an ArrayIndexOutOfBoundsException if index is negative.  
Parameters:
index -
arrow_up


add

public boolean add(Object o)


Appends the specified element to the end of this list.  
Parameters:
o - element to be appended to this list.
Returns:
true (as per the general contract of Collection.add).
arrow_up


add

public void add(int index, Object element)


Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).  
Parameters:
index - index at which the specified element is to be inserted.
element - element to be inserted.
Exceptions:
IndexOutOfBoundsException if index is out of range (index < 0 || index > size()).
arrow_up


addAll

public boolean addAll(Collection c)


Appends all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator. The behavior of this operation is undefined if the specified Collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified Collection is this list, and this list is nonempty.)  
Parameters:
c - the elements to be inserted into this list.
Returns:
true if this list changed as a result of the call.
Exceptions:
NullPointerException if the specified collection is null.
arrow_up


addAll

public boolean addAll(int index, Collection c)


Inserts all of the elements in the specified Collection into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the list in the order that they are returned by the specified Collection's iterator.  
Parameters:
index - index at which to insert first element from the specified collection.
c - elements to be inserted into this list.
Returns:
true if this list changed as a result of the call.
Exceptions:
NullPointerException if the specified Collection is null.
arrow_up


clear

public void clear()


Removes all of the elements from this list. The list will be empty after this call returns.  
arrow_up


clone

public Object clone()


Returns a shallow copy of this ArrayList instance. (The elements themselves are not copied.)  
Returns:
a clone of this ArrayList instance.
arrow_up


contains

public boolean contains(Object elem)


Returns true if this list contains the specified element.  
Parameters:
elem - element whose presence in this List is to be tested.
Returns:
true if the specified element is present; false otherwise.
arrow_up


ensureCapacity

public void ensureCapacity(int minCapacity)


Increases the capacity of this ArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.  
Parameters:
minCapacity - the desired minimum capacity.
arrow_up


get

public Object get(int index)


Returns the element at the specified position in this list.  
Parameters:
index - index of element to return.
Returns:
the element at the specified position in this list.
Exceptions:
IndexOutOfBoundsException if index is out of range (index < 0 || index >= size()).
arrow_up


indexOf

public int indexOf(Object elem)


Searches for the first occurence of the given argument, testing for equality using the equals method.  
Parameters:
elem - an object.
Returns:
the index of the first occurrence of the argument in this list; returns -1 if the object is not found.
See also:
Object#equals(Object)
arrow_up


isEmpty

public boolean isEmpty()


Tests if this list has no elements.  
Returns:
true if this list has no elements; false otherwise.
arrow_up


lastIndexOf

public int lastIndexOf(Object elem)


Returns the index of the last occurrence of the specified object in this list.  
Parameters:
elem - the desired element.
Returns:
the index of the last occurrence of the specified object in this list; returns -1 if the object is not found.
arrow_up


readObject

private void readObject(ObjectInputStream s)


Reconstitute the ArrayList instance from a stream (that is, deserialize it).  
Parameters:
s -
arrow_up


remove

public Object remove(int index)


Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices).  
Parameters:
index - the index of the element to removed.
Returns:
the element that was removed from the list.
Exceptions:
IndexOutOfBoundsException if index out of range (index < 0 || index >= size()).
arrow_up


removeRange

protected void removeRange(int fromIndex, int toIndex)


Removes from this List all of the elements whose index is between fromIndex, inclusive and toIndex, exclusive. Shifts any succeeding elements to the left (reduces their index). This call shortens the list by (toIndex - fromIndex) elements. (If toIndex==fromIndex, this operation has no effect.)  
Parameters:
fromIndex - index of first element to be removed.
toIndex - index after last element to be removed.
arrow_up


set

public Object set(int index, Object element)


Replaces the element at the specified position in this list with the specified element.  
Parameters:
index - index of element to replace.
element - element to be stored at the specified position.
Returns:
the element previously at the specified position.
Exceptions:
IndexOutOfBoundsException if index out of range (index < 0 || index >= size()).
arrow_up


size

public int size()


Returns the number of elements in this list.  
Returns:
the number of elements in this list.
arrow_up


toArray

public Object[] toArray()


Returns an array containing all of the elements in this list in the correct order.  
Returns:
an array containing all of the elements in this list in the correct order.
arrow_up


toArray

public Object[] toArray(Object[] a)


Returns an array containing all of the elements in this list in the correct order; the runtime type of the returned array is that of the specified array. If the list fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list.

If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.  

Parameters:
a - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
Returns:
an array containing the elements of the list.
Exceptions:
ArrayStoreException if the runtime type of a is not a supertype of the runtime type of every element in this list.
arrow_up


trimToSize

public void trimToSize()


Trims the capacity of this ArrayList instance to be the list's current size. An application can use this operation to minimize the storage of an ArrayList instance.  
arrow_up


writeObject

private void writeObject(ObjectOutputStream s)


Save the state of the ArrayList instance to a stream (that is, serialize it).  
Parameters:
s -
arrow_up
Created  2004 - 12 - 1

    Poseidon for UMLTM
  UMLdoc
 PREV  CLASSIFIER    NEXT  CLASSIFIER     FRAMES    NO FRAMES      
SUMMARY:   INNER | ATTR | ASSOC | CONSTR | METHOD     DETAIL:   INNER | ATTR | ASSOC | CONSTR | METHOD     DIAGRAMS:   COLLAB | SEQ | STATE | ACTIV

Generated with Poseidon for UMLTM.
Poseidon is a registered trademark of Gentleware AG in Germany, USA and other countries. Copyright 2003-2004 Gentleware AG, Schanzenstr. 70, 20357 Hamburg, Germany. All Rights Reserved.

UML is a trademark or registered trademark of Object Management Group, Inc. in the U.S. and other countries.