org.apache.commons.collections.primitives
public interface ShortCollection
short
values.
Since: Commons Primitives 1.0
Version: $Revision: 1.3 $ $Date: 2003/10/16 20:49:36 $
See Also: ShortCollectionCollection
Method Summary | |
---|---|
boolean | add(short element)
Ensures that I contain the specified element
(optional operation). |
boolean | addAll(ShortCollection c)Adds all of the elements in the
specified collection to me (optional operation).
|
void | clear()
Removes all my elements (optional operation).
|
boolean | contains(short element)
Returns true iff I contain
the specified element.
|
boolean | containsAll(ShortCollection c)
Returns true iff I contain
all of the elements in the given collection.
|
boolean | isEmpty()
Returns true iff I contain no elements. |
ShortIterator | iterator()
Returns an iterator over all my elements.
|
boolean | removeAll(ShortCollection c)
Removes all of my elements that are contained in the
specified collection (optional operation).
|
boolean | removeElement(short element)
Removes a single occurrence of the specified element
(optional operation).
|
boolean | retainAll(ShortCollection c)
Removes all of my elements that are not contained in the
specified collection (optional operation).
|
int | size()
Returns the number of elements I contain. |
short[] | toArray()
Returns an array containing all of my elements.
|
short[] | toArray(short[] a)
Returns an array containing all of my elements,
using the given array if it is large
enough. |
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
Returns: true
iff I changed as a result of this call
Throws: UnsupportedOperationException when this operation is not supported IllegalArgumentException may be thrown if some aspect of the specified element prevents it from being added to me
Adds
all of the elements in the
specified collection to me (optional operation).
Parameters: c the collection of elements whose presence within me is to be ensured
Returns: true
iff I changed as a result of this call
Throws: UnsupportedOperationException when this operation is not supported IllegalArgumentException may be thrown if some aspect of some specified element prevents it from being added to me
empty
after this
method successfully returns.
Throws: UnsupportedOperationException when this operation is not supported
true
iff I contain
the specified element.
Parameters: element the value whose presence within me is to be tested
Returns: true
iff I contain the specified element
true
iff I contain
all of the elements in the given collection.
Parameters: c the collection of elements whose presence within me is to be tested
Returns: true
iff I contain the all the specified elements
true
iff I contain no elements.Returns: true
iff I contain no elements.
iterator
over all my elements.
This base interface places no constraints on the order
in which the elements are returned by the returned iterator.Returns: an iterator
over all my elements.
Parameters: c the collection of elements to remove
Returns: true
iff I contained the at least one of the
specified elements, in other words, returns true
iff I changed as a result of this call
Throws: UnsupportedOperationException when this operation is not supported
Parameters: element the element to remove, if present
Returns: true
iff I contained the specified element,
in other words, iff I changed as a result of this call
Throws: UnsupportedOperationException when this operation is not supported
Parameters: c the collection of elements to retain
Returns: true
iff I changed as a result
of this call
Throws: UnsupportedOperationException when this operation is not supported
Returns: the number of elements I contain
size
.
The returned array will be independent of me,
so that callers may modify that
returned array without modifying this collection.
When I guarantee the order in which
elements are returned by an iterator
,
the returned array will contain elements in the
same order.
Returns: an array containing all my elements
iterator
,
the returned array will contain elements in the
same order.
Parameters: a an array that may be used to contain the elements
Returns: an array containing all my elements