org.objectweb.jorm.facility.meminst.genclass.api
Interface Collection

All Known Implementing Classes:

Collection

public interface Collection

Author:

Sebastien Chassande-Barrioz

Method Summary

boolean	add(java.lang.Object o, java.lang.Object connection) Ensures that this collection contains the specified element (optional operation).
boolean	addAll(Collection c, java.lang.Object connection) Adds all of the elements in the specified collection to this collection (optional operation).
void	clear(java.lang.Object connection) Removes all of the elements from this collection (optional operation).
boolean	contains(java.lang.Object o, java.lang.Object connection) Returns true if this collection contains the specified element.
boolean	containsAll(Collection c, java.lang.Object connection) Returns true if this collection contains all of the elements in the specified collection.
boolean	isEmpty(java.lang.Object connection) Returns true if this collection contains no elements.
java.util.Iterator	iterator(java.lang.Object connection) Returns an iterator over the elements in this collection.
boolean	remove(java.lang.Object o, java.lang.Object connection) Removes a single instance of the specified element from this collection, if it is present (optional operation).
boolean	removeAll(Collection c, java.lang.Object connection) Removes all this collection's elements that are also contained in the specified collection (optional operation).
boolean	retainAll(Collection c, java.lang.Object connection) Retains only the elements in this collection that are contained in the specified collection (optional operation).
int	size(java.lang.Object connection) Returns the number of elements in this collection.
java.lang.Object[]	toArray(java.lang.Object connection) Returns an array containing all of the elements in this collection.
java.lang.Object[]	toArray(java.lang.Object[] a, java.lang.Object connection) Returns an array containing all of the elements in this collection whose runtime type is that of the specified array.

Method Detail

size

public int size(java.lang.Object connection)
         throws PException

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Parameters:

connection - used to access the data store

Returns:

the number of elements in this collection

Throws:

PException - a internal jorm error occured

isEmpty

public boolean isEmpty(java.lang.Object connection)
                throws PException

Returns true if this collection contains no elements.

Parameters:

connection - used to access the data store

Returns:

true if this collection contains no elements

contains

public boolean contains(java.lang.Object o,
                        java.lang.Object connection)
                 throws PException

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).

Parameters:

connection - used to access the data store

o - element whose presence in this collection is to be tested.

Returns:

true if this collection contains the specified element

Throws:

PException - a internal jorm error occured

iterator

public java.util.Iterator iterator(java.lang.Object connection)
                            throws PException

Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides a guarantee).

Parameters:

connection - used to access the data store

Returns:

an Iterator over the elements in this collection

Throws:

PException - a internal jorm error occured

toArray

public java.lang.Object[] toArray(java.lang.Object connection)
                           throws PException

Returns an array containing all of the elements in this collection. If the collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Parameters:

connection - used to access the data store

Returns:

an array containing all of the elements in this collection

Throws:

PException - a internal jorm error occured

toArray

public java.lang.Object[] toArray(java.lang.Object[] a,
                                  java.lang.Object connection)
                           throws PException

Returns an array containing all of the elements in this collection whose runtime type is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.

If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of this collection only if the caller knows that this collection does not contain any null elements.)

If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs

Suppose l is a List known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:

     String[] x = (String[]) v.toArray(new String[0]);
 

Note that toArray(new Object[0]) is identical in function to toArray().

Parameters:

connection - used to access the data store

a - the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing the elements of this collection

Throws:

ArrayStoreException - the runtime type of the specified array is not a supertype of the runtime type of every element in this collection.

PException - a internal jorm error occured

add

public boolean add(java.lang.Object o,
                   java.lang.Object connection)
            throws PException

Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.)

Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Parameters:

o - element whose presence in this collection is to be ensured.

connection - used to access the data store

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - add is not supported by this collection.

ClassCastException - class of the specified element prevents it from being added to this collection.

java.lang.IllegalArgumentException - some aspect of this element prevents it from being added to this collection.

PException - a internal jorm error occured

remove

public boolean remove(java.lang.Object o,
                      java.lang.Object connection)
               throws PException

Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).

Parameters:

o - element to be removed from this collection, if present.

connection - used to access the data store

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - remove is not supported by this collection.

PException - a internal jorm error occured

containsAll

public boolean containsAll(Collection c,
                           java.lang.Object connection)
                    throws PException

Returns true if this collection contains all of the elements in the specified collection.

Parameters:

c - collection to be checked for containment in this collection.

connection - used to access the data store

Returns:

true if this collection contains all of the elements in the specified collection

Throws:

PException - a internal jorm error occured

See Also:

#contains(Object)

addAll

public boolean addAll(Collection c,
                      java.lang.Object connection)
               throws PException

Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)

Parameters:

c - elements to be inserted into this collection.

connection - used to access the data store

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if this collection does not support the addAll method.

ClassCastException - if the class of an element of the specified collection prevents it from being added to this collection.

java.lang.IllegalArgumentException - some aspect of an element of the specified collection prevents it from being added to this collection.

PException - a internal jorm error occured

See Also:

#add(Object)

removeAll

public boolean removeAll(Collection c,
                         java.lang.Object connection)
                  throws PException

Removes all this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.

Parameters:

c - elements to be removed from this collection.

connection - used to access the data store

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if the removeAll method is not supported by this collection.

PException - a internal jorm error occured

See Also:

#remove(Object), #contains(Object)

retainAll

public boolean retainAll(Collection c,
                         java.lang.Object connection)
                  throws PException

Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.

Parameters:

c - elements to be retained in this collection.

connection - used to access the data store

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if the retainAll method is not supported by this Collection.

PException - a internal jorm error occured

See Also:

#remove(Object), #contains(Object)

clear

public void clear(java.lang.Object connection)
           throws PException

Removes all of the elements from this collection (optional operation). This collection will be empty after this method returns unless it throws an exception.

Parameters:

connection - used to access the data store

Throws:

java.lang.UnsupportedOperationException - if the clear method is not supported by this collection.

PException - a internal jorm error occured