File	Doc	Category	Size	Date	Package
ShortList.java	API Doc	Apache Poi 3.0.1	18101	Mon Jan 01 12:39:42 GMT 2007	org.apache.poi.util

ShortList

• java.lang.Object

Fields Summary
private short[]	_array
private int	_limit
private static final int	_default_size

Constructors Summary
public ShortList() create an ShortList of default size this(_default_size);
public ShortList(ShortList list) create a copy of an existing ShortList param list the existing ShortList this(list._array.length); System.arraycopy(list._array, 0, _array, 0, _array.length); _limit = list._limit;
public ShortList(int initialCapacity) create an ShortList with a predefined initial size param initialCapacity the size for the internal array _array = new short[ initialCapacity ]; _limit = 0;

Methods Summary
public void	add(int index, short value) add the specfied value at the specified index param index the index where the new value is to be added param value the new value exception IndexOutOfBoundsException if the index is out of range (index < 0 || index > size()). if (index > _limit) { throw new IndexOutOfBoundsException(); } else if (index == _limit) { add(value); } else { // index < limit -- insert into the middle if (_limit == _array.length) { growArray(_limit * 2); } System.arraycopy(_array, index, _array, index + 1, _limit - index); _array[ index ] = value; _limit++; }
public boolean	add(short value) Appends the specified element to the end of this list param value element to be appended to this list. return true (as per the general contract of the Collection.add method). if (_limit == _array.length) { growArray(_limit * 2); } _array[ _limit++ ] = value; return true;
public boolean	addAll(org.apache.poi.util.ShortList 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 unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.) param c collection whose elements are to be added to this list. return true if this list changed as a result of the call. if (c._limit != 0) { if ((_limit + c._limit) > _array.length) { growArray(_limit + c._limit); } System.arraycopy(c._array, 0, _array, _limit, c._limit); _limit += c._limit; } return true;
public boolean	addAll(int index, org.apache.poi.util.ShortList c) Inserts all of the elements in the specified collection into this list 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 this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.) param index index at which to insert first element from the specified collection. param c elements to be inserted into this list. return true if this list changed as a result of the call. exception IndexOutOfBoundsException if the index is out of range (index < 0 || index > size()) if (index > _limit) { throw new IndexOutOfBoundsException(); } if (c._limit != 0) { if ((_limit + c._limit) > _array.length) { growArray(_limit + c._limit); } // make a hole System.arraycopy(_array, index, _array, index + c._limit, _limit - index); // fill it in System.arraycopy(c._array, 0, _array, index, c._limit); _limit += c._limit; } return true;
public void	clear() Removes all of the elements from this list. This list will be empty after this call returns (unless it throws an exception). _limit = 0;
public boolean	contains(short o) Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that o == e param o element whose presence in this list is to be tested. return true if this list contains the specified element. boolean rval = false; for (int j = 0; !rval && (j < _limit); j++) { if (_array[ j ] == o) { rval = true; } } return rval;
public boolean	containsAll(org.apache.poi.util.ShortList c) Returns true if this list contains all of the elements of the specified collection. param c collection to be checked for containment in this list. return true if this list contains all of the elements of the specified collection. boolean rval = true; if (this != c) { for (int j = 0; rval && (j < c._limit); j++) { if (!contains(c._array[ j ])) { rval = false; } } } return rval;
public boolean	equals(java.lang.Object o) Compares the specified object with this list for equality. Returns true if and only if the specified object is also a list, both lists have the same size, and all corresponding pairs of elements in the two lists are equal. (Two elements e1 and e2 are equal if e1 == e2.) In other words, two lists are defined to be equal if they contain the same elements in the same order. This definition ensures that the equals method works properly across different implementations of the List interface. param o the object to be compared for equality with this list. return true if the specified object is equal to this list. boolean rval = this == o; if (!rval && (o != null) && (o.getClass() == this.getClass())) { ShortList other = ( ShortList ) o; if (other._limit == _limit) { // assume match rval = true; for (int j = 0; rval && (j < _limit); j++) { rval = _array[ j ] == other._array[ j ]; } } } return rval;
public short	get(int index) Returns the element at the specified position in this list. param index index of element to return. return the element at the specified position in this list. exception IndexOutOfBoundsException if the index is out of range (index < 0 || index >= size()). if (index >= _limit) { throw new IndexOutOfBoundsException(); } return _array[ index ];
private void	growArray(int new_size) int size = (new_size == _array.length) ? new_size + 1 : new_size; short[] new_array = new short[ size ]; System.arraycopy(_array, 0, new_array, 0, _limit); _array = new_array;
public int	hashCode() Returns the hash code value for this list. The hash code of a list is defined to be the result of the following calculation: hashCode = 1; Iterator i = list.iterator(); while (i.hasNext()) { Object obj = i.next(); hashCode = 31*hashCode + (obj==null ? 0 : obj.hashCode()); } This ensures that list1.equals(list2) implies that list1.hashCode()==list2.hashCode() for any two lists, list1 and list2, as required by the general contract of Object.hashCode. return the hash code value for this list. int hash = 0; for (int j = 0; j < _limit; j++) { hash = (31 * hash) + _array[ j ]; } return hash;
public int	indexOf(short o) Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the lowest index i such that (o == get(i)), or -1 if there is no such index. param o element to search for. return the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element. int rval = 0; for (; rval < _limit; rval++) { if (o == _array[ rval ]) { break; } } if (rval == _limit) { rval = -1; // didn't find it } return rval;
public boolean	isEmpty() Returns true if this list contains no elements. return true if this list contains no elements. return _limit == 0;
public int	lastIndexOf(short o) Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the highest index i such that (o == get(i)), or -1 if there is no such index. param o element to search for. return the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element. int rval = _limit - 1; for (; rval >= 0; rval--) { if (o == _array[ rval ]) { break; } } return rval;
public short	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). Returns the element that was removed from the list. param index the index of the element to removed. return the element previously at the specified position. exception IndexOutOfBoundsException if the index is out of range (index < 0 || index >= size()). if (index >= _limit) { throw new IndexOutOfBoundsException(); } short rval = _array[ index ]; System.arraycopy(_array, index + 1, _array, index, _limit - index); _limit--; return rval;
public boolean	removeAll(org.apache.poi.util.ShortList c) Removes from this list all the elements that are contained in the specified collection param c collection that defines which elements will be removed from this list. return true if this list changed as a result of the call. boolean rval = false; for (int j = 0; j < c._limit; j++) { if (removeValue(c._array[ j ])) { rval = true; } } return rval;
public boolean	removeValue(short o) Removes the first occurrence in this list of the specified element (optional operation). If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that (o.equals(get(i))) (if such an element exists). param o element to be removed from this list, if present. return true if this list contained the specified element. boolean rval = false; for (int j = 0; !rval && (j < _limit); j++) { if (o == _array[ j ]) { System.arraycopy(_array, j + 1, _array, j, _limit - j); _limit--; rval = true; } } return rval;
public boolean	retainAll(org.apache.poi.util.ShortList c) Retains only the elements in this list that are contained in the specified collection. In other words, removes from this list all the elements that are not contained in the specified collection. param c collection that defines which elements this set will retain. return true if this list changed as a result of the call. boolean rval = false; for (int j = 0; j < _limit; ) { if (!c.contains(_array[ j ])) { remove(j); rval = true; } else { j++; } } return rval;
public short	set(int index, short element) Replaces the element at the specified position in this list with the specified element param index index of element to replace. param element element to be stored at the specified position. return the element previously at the specified position. exception IndexOutOfBoundsException if the index is out of range (index < 0 || index >= size()). if (index >= _limit) { throw new IndexOutOfBoundsException(); } short rval = _array[ index ]; _array[ index ] = element; return rval;
public int	size() Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE. return the number of elements in this ShortList return _limit;
public short[]	toArray() Returns an array containing all of the elements in this list in proper sequence. Obeys the general contract of the Collection.toArray method. return an array containing all of the elements in this list in proper sequence. short[] rval = new short[ _limit ]; System.arraycopy(_array, 0, rval, 0, _limit); return rval;
public short[]	toArray(short[] a) Returns an array containing all of the elements in this list in proper sequence. Obeys the general contract of the Collection.toArray(Object[]) method. param a the array into which the elements of this list are to be stored, if it is big enough; otherwise, a new array is allocated for this purpose. return an array containing the elements of this list. short[] rval; if (a.length == _limit) { System.arraycopy(_array, 0, a, 0, _limit); rval = a; } else { rval = toArray(); } return rval;