| org.apache.commons.collections.primitives.CharList
All known Subclasses: org.apache.commons.collections.primitives.adapters.AbstractListCharList, org.apache.commons.collections.primitives.ArrayCharList, org.apache.commons.collections.primitives.RandomAccessCharList, org.apache.commons.collections.primitives.decorators.BaseProxyCharList,
| Method Summary | |
| boolean | add(char element)
Appends the specified element to the end of me
(optional operation). | | void | add(int index, char element)
Inserts the specified element at the specified position
(optional operation). | | boolean | addAll(int index, CharCollection collection)
Inserts all of the elements in the specified collection into me,
at the specified position (optional operation). | | boolean | equals(Object that)
Returns true iff that is an CharList
that contains the same elements in the same order as me. | | char | get(int index)
Returns the value of the element at the specified position
within me. | | int | hashCode()
Returns my hash code.
The hash code of an CharList is defined to be the
result of the following calculation:
int hash = 1;
for(CharIterator iter = iterator(); iter.hasNext(); ) {
char value = iter.next();
hash = 31*hash + (int)(value ^ (value >>> 32));
}
This contract ensures that this method is consistent with
CharList.equals equals and with the
java.util.List.hashCode hashCode method of a
java.util.List List of
Character s. | | int | indexOf(char element)
Returns the index of the first occurrence
of the specified element within me,
or -1 if I do not contain
the element. | | CharIterator | iterator()
Returns an
CharIterator iterator over all my elements,
in the appropriate sequence. | | int | lastIndexOf(char element)
Returns the index of the last occurrence
of the specified element within me,
or -1 if I do not contain the element. | | CharListIterator | listIterator()
Returns a
CharListIterator bidirectional iterator over all my elements, in the appropriate sequence. | | CharListIterator | listIterator(int index)
Returns a
CharListIterator bidirectional iterator over all my elements, in the appropriate sequence,
starting at the specified position. | | char | removeElementAt(int index)
Removes the element at the specified position in
(optional operation). | | char | set(int index, char element)
Replaces the element at the specified
position in me with the specified element
(optional operation). | | CharList | subList(int fromIndex, int toIndex)
Returns a view of the elements within me
between the specified fromIndex, inclusive, and
toIndex, exclusive. |
| add | | boolean add(char element)(Code) | | Appends the specified element to the end of me
(optional operation). Returns true
iff I changed as a result of this call.
If a collection refuses to add the specified
element for any reason other than that it already contains
the element, it must throw an exception (rather than
simply returning false). This preserves the invariant
that a collection always contains the specified element after
this call returns.
Parameters:
element - the value whose presence within me is to be ensured true iff I changed as a result of this call
throws:
UnsupportedOperationException - when this operation is not supported
throws:
IllegalArgumentException - may be thrown if some aspect of the specified element prevents it from being added to me |
| add | | void add(int index, char element)(Code) | | Inserts the specified element at the specified position
(optional operation). Shifts the element currently
at that position (if any) and any subsequent elements to the
right, increasing their indices.
Parameters:
index - the index at which to insert the element
Parameters:
element - the value to insert
throws:
UnsupportedOperationException - when this operation is not supported
throws:
IllegalArgumentException - if some aspect of the specified element prevents it from being added to me
throws:
IndexOutOfBoundsException - if the specified index is out of range |
| addAll | | boolean addAll(int index, CharCollection collection)(Code) | | Inserts all of the elements in the specified collection into me,
at the specified position (optional operation). Shifts the
element currently at that position (if any) and any subsequent
elements to the right, increasing their indices. The new elements
will appear in the order that they are returned by the given
collection's
CharCollection.iterator iterator .
Parameters:
index - the index at which to insert the first element from the specified collection
Parameters:
collection - the CharCollection CharCollection of elements to add true iff I changed as a result of this call
throws:
UnsupportedOperationException - when this operation is not supported
throws:
IndexOutOfBoundsException - if the specified index is out of range |
| equals | | boolean equals(Object that)(Code) | | Returns true iff that is an CharList
that contains the same elements in the same order as me.
In other words, returns true iff that is
an CharList that has the same
CharList.size size as me,
and for which the elements returned by its
CharList.iterator iterator are equal (==) to
the corresponding elements within me.
(This contract ensures that this method works properly across
different implementations of the CharList interface.)
Parameters:
that - the object to compare to me true iff that is an CharListthat contains the same elements in the same order as me |
| get | | char get(int index)(Code) | | Returns the value of the element at the specified position
within me.
Parameters:
index - the index of the element to return the value of the element at the specified position
throws:
IndexOutOfBoundsException - if the specified index is out of range |
| hashCode | | int hashCode()(Code) | | Returns my hash code.
The hash code of an CharList is defined to be the
result of the following calculation:
int hash = 1;
for(CharIterator iter = iterator(); iter.hasNext(); ) {
char value = iter.next();
hash = 31*hash + (int)(value ^ (value >>> 32));
}
This contract ensures that this method is consistent with
CharList.equals equals and with the
java.util.List.hashCode hashCode method of a
java.util.List List of
Character s.
my hash code |
| indexOf | | int indexOf(char element)(Code) | | Returns the index of the first occurrence
of the specified element within me,
or -1 if I do not contain
the element.
Parameters:
element - the element to search for the smallest index of an element matching the specified value,or -1 if no such matching element can be found |
| lastIndexOf | | int lastIndexOf(char element)(Code) | | Returns the index of the last occurrence
of the specified element within me,
or -1 if I do not contain the element.
Parameters:
element - the element to search for the largest index of an element matching the specified value,or -1 if no such matching element can be found |
| removeElementAt | | char removeElementAt(int index)(Code) | | Removes the element at the specified position in
(optional operation). Any subsequent elements
are shifted to the left, subtracting one from their
indices. Returns the element that was removed.
Parameters:
index - the index of the element to remove the value of the element that was removed
throws:
UnsupportedOperationException - when this operation is not supported
throws:
IndexOutOfBoundsException - if the specified index is out of range |
| set | | char set(int index, char element)(Code) | | Replaces the element at the specified
position in me with the specified element
(optional operation).
Parameters:
index - the index of the element to change
Parameters:
element - the value to be stored at the specified position the value previously stored at the specified position
throws:
UnsupportedOperationException - when this operation is not supported
throws:
IndexOutOfBoundsException - if the specified index is out of range |
| subList | | CharList subList(int fromIndex, int toIndex)(Code) | | Returns a view of the elements within me
between the specified fromIndex, inclusive, and
toIndex, exclusive. The returned CharList
is backed by me, so that any changes in
the returned list are reflected in me, and vice-versa.
The returned list supports all of the optional operations
that I support.
Note that when fromIndex == toIndex,
the returned list is initially empty, and when
fromIndex == 0 && toIndex ==
CharList.size() size()
the returned list is my "improper" sublist, containing all my elements.
The semantics of the returned list become undefined
if I am structurally modified in any way other than
via the returned list.
Parameters:
fromIndex - the smallest index (inclusive) in me that appears in the returned list
Parameters:
toIndex - the largest index (exclusive) in me that appears in the returned list a view of this list from fromIndex (inclusive) to toIndex (exclusive)
throws:
IndexOutOfBoundsException - if either specified index is out of range |
|
|