| java.lang.Object
 org.apache.poi.util.ShortList
| ShortList | | public class ShortList (Code) | | A List of short's; as full an implementation of the java.util.List
interface as possible, with an eye toward minimal creation of
objects
the mimicry of List is as follows:
- if possible, operations designated 'optional' in the List
interface are attempted
- wherever the List interface refers to an Object, substitute
short
- wherever the List interface refers to a Collection or List,
substitute ShortList
the mimicry is not perfect, however:
- operations involving Iterators or ListIterators are not
supported
- remove(Object) becomes removeValue to distinguish it from
remove(short index)
- subList is not supported
author:
Marc Johnson |
| Method Summary | |
| public void | add(int index, short value)
| | public boolean | add(short value)
Appends the specified element to the end of this list
Parameters:
value - element to be appended to this list. | | public boolean | addAll(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. | | public boolean | addAll(int index, ShortList c)
Inserts all of the elements in the specified collection into
this list at the specified position. | | public void | clear()
Removes all of the elements from this list. | | public boolean | contains(short o)
Returns true if this list contains the specified element. | | public boolean | containsAll(ShortList c)
Returns true if this list contains all of the elements of the
specified collection.
Parameters:
c - collection to be checked for containment in this list. | | public boolean | equals(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. | | public short | get(int index)
Returns the element at the specified position in this list.
Parameters:
index - index of element to return. | | public int | hashCode()
Returns the hash code value for this list. | | 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. | | public boolean | isEmpty()
Returns true if this list contains no elements. | | 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. | | 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). | | public boolean | removeAll(ShortList c)
Removes from this list all the elements that are contained in
the specified collection
Parameters:
c - collection that defines which elements will be removedfrom this list. | | public boolean | removeValue(short o)
Removes the first occurrence in this list of the specified
element (optional operation). | | public boolean | retainAll(ShortList c)
Retains only the elements in this list that are contained in
the specified collection. | | public short | set(int index, short element)
Replaces the element at the specified position in this list
with the specified element
Parameters:
index - index of element to replace.
Parameters:
element - element to be stored at the specified position. | | public int | size()
Returns the number of elements in this list. | | public short[] | toArray()
Returns an array containing all of the elements in this list in
proper sequence. | | public short[] | toArray(short[] a)
Returns an array containing all of the elements in this list in
proper sequence. |
| ShortList | | public ShortList()(Code) | | create an ShortList of default size
|
| ShortList | | public ShortList(ShortList list)(Code) | | create a copy of an existing ShortList
Parameters:
list - the existing ShortList |
| ShortList | | public ShortList(int initialCapacity)(Code) | | create an ShortList with a predefined initial size
Parameters:
initialCapacity - the size for the internal array |
| add | | public void add(int index, short value)(Code) | | add the specfied value at the specified index
Parameters:
index - the index where the new value is to be added
Parameters:
value - the new value
exception:
IndexOutOfBoundsException - if the index is out ofrange (index < 0 || index > size()). |
| add | | public boolean add(short value)(Code) | | Appends the specified element to the end of this list
Parameters:
value - element to be appended to this list. true (as per the general contract of the Collection.addmethod). |
| addAll | | public boolean addAll(ShortList c)(Code) | | 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.)
Parameters:
c - collection whose elements are to be added to thislist. true if this list changed as a result of the call. |
| addAll | | public boolean addAll(int index, ShortList c)(Code) | | 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.)
Parameters:
index - index at which to insert first element from thespecified collection.
Parameters:
c - elements to be inserted into this list. true if this list changed as a result of the call.
exception:
IndexOutOfBoundsException - if the index is out ofrange (index < 0 || index > size()) |
| clear | | public void clear()(Code) | | Removes all of the elements from this list. This list will be
empty after this call returns (unless it throws an exception).
|
| contains | | public boolean contains(short o)(Code) | | 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
Parameters:
o - element whose presence in this list is to be tested. true if this list contains the specified element. |
| containsAll | | public boolean containsAll(ShortList c)(Code) | | Returns true if this list contains all of the elements of the
specified collection.
Parameters:
c - collection to be checked for containment in this list. true if this list contains all of the elements of thespecified collection. |
| equals | | public boolean equals(Object o)(Code) | | 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.
Parameters:
o - the object to be compared for equality with this list. true if the specified object is equal to this list. |
| get | | public short get(int index)(Code) | | Returns the element at the specified position in this list.
Parameters:
index - index of element to return. the element at the specified position in this list.
exception:
IndexOutOfBoundsException - if the index is out ofrange (index < 0 || index >= size()). |
| hashCode | | public int hashCode()(Code) | | 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.
the hash code value for this list. |
| indexOf | | public int indexOf(short o)(Code) | | 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.
Parameters:
o - element to search for. the index in this list of the first occurrence of thespecified element, or -1 if this list does not containthis element. |
| isEmpty | | public boolean isEmpty()(Code) | | Returns true if this list contains no elements.
true if this list contains no elements. |
| lastIndexOf | | public int lastIndexOf(short o)(Code) | | 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.
Parameters:
o - element to search for. the index in this list of the last occurrence of thespecified element, or -1 if this list does not containthis element. |
| remove | | public short remove(int index)(Code) | | 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.
Parameters:
index - the index of the element to removed. the element previously at the specified position.
exception:
IndexOutOfBoundsException - if the index is out ofrange (index < 0 || index >= size()). |
| removeAll | | public boolean removeAll(ShortList c)(Code) | | Removes from this list all the elements that are contained in
the specified collection
Parameters:
c - collection that defines which elements will be removedfrom this list. true if this list changed as a result of the call. |
| removeValue | | public boolean removeValue(short o)(Code) | | 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).
Parameters:
o - element to be removed from this list, if present. true if this list contained the specified element. |
| retainAll | | public boolean retainAll(ShortList c)(Code) | | 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.
Parameters:
c - collection that defines which elements this set willretain. true if this list changed as a result of the call. |
| set | | public short set(int index, short element)(Code) | | Replaces the element at the specified position in this list
with the specified element
Parameters:
index - index of element to replace.
Parameters:
element - element to be stored at the specified position. the element previously at the specified position.
exception:
IndexOutOfBoundsException - if the index is out ofrange (index < 0 || index >= size()). |
| size | | public int size()(Code) | | Returns the number of elements in this list. If this list
contains more than Integer.MAX_VALUE elements, returns
Integer.MAX_VALUE.
the number of elements in this ShortList |
| toArray | | public short[] toArray()(Code) | | Returns an array containing all of the elements in this list in
proper sequence. Obeys the general contract of the
Collection.toArray method.
an array containing all of the elements in this list inproper sequence. |
| toArray | | public short[] toArray(short[] a)(Code) | | Returns an array containing all of the elements in this list in
proper sequence. Obeys the general contract of the
Collection.toArray(Object[]) method.
Parameters:
a - the array into which the elements of this list are tobe stored, if it is big enough; otherwise, a new arrayis allocated for this purpose. an array containing the elements of this list. |
|
|