|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ShortList
An ordered collection of short
values.
ShortListList
,
ListShortList
Method Summary | |
---|---|
void |
add(int index,
short element)
Inserts the specified element at the specified position (optional operation). |
boolean |
add(short element)
Appends the specified element to the end of me (optional operation). |
boolean |
addAll(int index,
ShortCollection collection)
Inserts all of the elements in the specified collection into me, at the specified position (optional operation). |
boolean |
equals(java.lang.Object that)
Returns true iff that is an ShortList
that contains the same elements in the same order as me. |
short |
get(int index)
Returns the value of the element at the specified position within me. |
int |
hashCode()
Returns my hash code. |
int |
indexOf(short element)
Returns the index of the first occurrence of the specified element within me, or -1 if I do not contain
the element. |
ShortIterator |
iterator()
Returns an iterator over all my elements,
in the appropriate sequence. |
int |
lastIndexOf(short element)
Returns the index of the last occurrence of the specified element within me, or -1 if I do not contain the element. |
ShortListIterator |
listIterator()
Returns a bidirectional iterator
over all my elements, in the appropriate sequence. |
ShortListIterator |
listIterator(int index)
Returns a bidirectional iterator
over all my elements, in the appropriate sequence,
starting at the specified position. |
short |
removeElementAt(int index)
Removes the element at the specified position in (optional operation). |
short |
set(int index,
short element)
Replaces the element at the specified position in me with the specified element (optional operation). |
ShortList |
subList(int fromIndex,
int toIndex)
Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive. |
Methods inherited from interface org.apache.commons.collections.primitives.ShortCollection |
---|
addAll, clear, contains, containsAll, isEmpty, removeAll, removeElement, retainAll, size, toArray, toArray |
Method Detail |
---|
boolean add(short element)
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.
add
in interface ShortCollection
element
- the value whose presence within me is to be ensured
true
iff I changed as a result of this call
java.lang.UnsupportedOperationException
- when this operation is not
supported
java.lang.IllegalArgumentException
- may be thrown if some aspect of the
specified element prevents it from being added to mevoid add(int index, short element)
index
- the index at which to insert the elementelement
- the value to insert
java.lang.UnsupportedOperationException
- when this operation is not
supported
java.lang.IllegalArgumentException
- if some aspect of the specified element
prevents it from being added to me
java.lang.IndexOutOfBoundsException
- if the specified index is out of rangeboolean addAll(int index, ShortCollection collection)
iterator
.
index
- the index at which to insert the first element from
the specified collectioncollection
- the ShortCollection
of elements to add
true
iff I changed as a result of this call
java.lang.UnsupportedOperationException
- when this operation is not
supported
java.lang.IndexOutOfBoundsException
- if the specified index is out of rangeboolean equals(java.lang.Object that)
true
iff that is an ShortList
that contains the same elements in the same order as me.
In other words, returns true
iff that is
an ShortList
that has the same size
as me,
and for which the elements returned by its
iterator
are equal (==
) to
the corresponding elements within me.
(This contract ensures that this method works properly across
different implementations of the ShortList
interface.)
equals
in class java.lang.Object
that
- the object to compare to me
true
iff that is an ShortList
that contains the same elements in the same order as meshort get(int index)
index
- the index of the element to return
java.lang.IndexOutOfBoundsException
- if the specified index is out of rangeint hashCode()
ShortList
is defined to be the
result of the following calculation:
int hash = 1; for(ShortIterator iter = iterator(); iter.hasNext(); ) { short value = iter.next(); hash = 31*hash + (int)(value ^ (value >>> 32)); }This contract ensures that this method is consistent with
equals
and with the
hashCode
method of a List
of Short
s.
hashCode
in class java.lang.Object
int indexOf(short element)
-1
if I do not contain
the element.
element
- the element to search for
-1
if no such matching element can be foundShortIterator iterator()
iterator
over all my elements,
in the appropriate sequence.
iterator
in interface ShortCollection
iterator
over all my elements.int lastIndexOf(short element)
element
- the element to search for
-1
if no such matching element can be foundShortListIterator listIterator()
bidirectional iterator
over all my elements, in the appropriate sequence.
ShortListIterator listIterator(int index)
bidirectional iterator
over all my elements, in the appropriate sequence,
starting at the specified position. The
specified index indicates the first
element that would be returned by an initial
call to the
next
method. An initial call to the
previous
method would return the element with the specified
index minus one.
java.lang.IndexOutOfBoundsException
- if the specified index is out of rangeshort removeElementAt(int index)
index
- the index of the element to remove
java.lang.UnsupportedOperationException
- when this operation is not
supported
java.lang.IndexOutOfBoundsException
- if the specified index is out of rangeshort set(int index, short element)
index
- the index of the element to changeelement
- the value to be stored at the specified position
java.lang.UnsupportedOperationException
- when this operation is not
supported
java.lang.IndexOutOfBoundsException
- if the specified index is out of rangeShortList subList(int fromIndex, int toIndex)
ShortList
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 == 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.
fromIndex
- the smallest index (inclusive) in me that appears in
the returned listtoIndex
- the largest index (exclusive) in me that appears in the
returned list
java.lang.IndexOutOfBoundsException
- if either specified index is out of range
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |