|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfabric.common.util.AbstractLongCollection
public abstract class AbstractLongCollection
A basic implementation of most of the methods in the Collection interface to make it easier to create a collection. To create an unmodifiable Collection, just subclass AbstractCollection and provide implementations of the iterator() and size() methods. The Iterator returned by iterator() need only provide implementations of hasNext() and next() (that is, it may throw an UnsupportedOperationException if remove() is called). To create a modifiable Collection, you must in addition provide an implementation of the add(Object) method and the Iterator returned by iterator() must provide an implementation of remove(). Other methods should be overridden if the backing data structure allows for a more efficient implementation. The precise implementation used by AbstractCollection is documented, so that subclasses can tell which methods could be implemented more efficiently.
The programmer should provide a no-argument constructor, and one that accepts another Collection, as recommended by the Collection interface. Unfortunately, there is no way to enforce this in Java.
LongCollection
,
AbstractLongSet
Constructor Summary | |
---|---|
protected |
AbstractLongCollection()
The main constructor, for use by subclasses. |
Method Summary | |
---|---|
boolean |
add(long o)
Add an object to the collection (optional operation). |
boolean |
addAll(LongCollection c)
Add all the elements of a given collection to this collection (optional operation). |
void |
clear()
Remove all elements from the collection (optional operation). |
boolean |
contains(long o)
Test whether this collection contains a given object. |
boolean |
containsAll(LongCollection c)
Tests whether this collection contains all the elements in a given collection. |
boolean |
isEmpty()
Test whether this collection is empty. |
abstract LongIterator |
iterator()
Return an Iterator over this collection. |
boolean |
remove(long o)
Remove a single instance of an object from this collection (optional operation). |
boolean |
removeAll(LongCollection c)
Remove from this collection all its elements that are contained in a given collection (optional operation). |
boolean |
retainAll(LongCollection c)
Remove from this collection all its elements that are not contained in a given collection (optional operation). |
abstract int |
size()
Return the number of elements in this collection. |
long[] |
toArray()
Return an array containing the elements of this collection. |
long[] |
toArray(long[] a)
Copy the collection into a given array if it will fit, or into a dynamically created array of the same run-time type as the given array if not. |
java.lang.String |
toString()
Creates a String representation of the Collection. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface fabric.common.util.LongCollection |
---|
equals, hashCode |
Constructor Detail |
---|
protected AbstractLongCollection()
Method Detail |
---|
public abstract LongIterator iterator()
iterator
in interface LongCollection
iterator
in interface LongIterable
public abstract int size()
size
in interface LongCollection
public boolean add(long o)
add
in interface LongCollection
o
- the object to add
java.lang.UnsupportedOperationException
- if the add operation is not
supported on this collection
java.lang.NullPointerException
- if the collection does not support null
java.lang.ClassCastException
- if the object is of the wrong type
java.lang.IllegalArgumentException
- if some aspect of the object prevents
it from being addedpublic boolean addAll(LongCollection c)
addAll
in interface LongCollection
c
- the collection to add the elements of to this collection
java.lang.UnsupportedOperationException
- if the add operation is not
supported on this collection
java.lang.NullPointerException
- if the specified collection is null
java.lang.ClassCastException
- if the type of any element in c is
not a valid type for addition.
java.lang.IllegalArgumentException
- if some aspect of any element
in c prevents it being added.
java.lang.NullPointerException
- if any element in c is null and this
collection doesn't allow null values.add(long)
public void clear()
clear
in interface LongCollection
java.lang.UnsupportedOperationException
- if the Iterator returned by
iterator does not provide an implementation of removeLongIterator.remove()
public boolean contains(long o)
contains
in interface LongCollection
o
- the object to remove from this collection
public boolean containsAll(LongCollection c)
containsAll
in interface LongCollection
c
- the collection to test against
java.lang.NullPointerException
- if the given collection is nullcontains(long)
public boolean isEmpty()
isEmpty
in interface LongCollection
size()
public boolean remove(long o)
(o == null ? e == null : o.equals(e))
, if such an element
exists. This implementation obtains an iterator over the collection
and iterates over it, testing each element for equality with the given
object. If it is equal, it is removed by the iterator's remove method
(thus this method will fail with an UnsupportedOperationException if
the Iterator's remove method does). After the first element has been
removed, true is returned; if the end of the collection is reached, false
is returned.
remove
in interface LongCollection
o
- the object to remove from this collection
java.lang.UnsupportedOperationException
- if this collection's Iterator
does not support the remove methodLongIterator.remove()
public boolean removeAll(LongCollection c)
removeAll
in interface LongCollection
c
- the collection to remove the elements of
java.lang.UnsupportedOperationException
- if this collection's Iterator
does not support the remove method
java.lang.NullPointerException
- if the collection, c, is null.LongIterator.remove()
public boolean retainAll(LongCollection c)
retainAll
in interface LongCollection
c
- the collection to retain the elements of
java.lang.UnsupportedOperationException
- if this collection's Iterator
does not support the remove method
java.lang.NullPointerException
- if the collection, c, is null.LongIterator.remove()
public long[] toArray()
toArray
in interface LongCollection
public long[] toArray(long[] a)
toArray
in interface LongCollection
a
- the array to copy into, or of the correct run-time type
java.lang.NullPointerException
- if the given array is null
java.lang.ArrayStoreException
- if the type of the array precludes holding
one of the elements of the Collectionpublic java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |