net.moioli.chart.swing
Class CollectionToCompatibleWrapper

java.lang.Object
  extended by net.moioli.chart.swing.CollectionToCompatibleWrapper
All Implemented Interfaces:
CompatibleCollection

public class CollectionToCompatibleWrapper
extends java.lang.Object
implements CompatibleCollection

This is just a stupid wrapper around Collection to solve an incompatibility between the Collection interface and the JPanel class.
Both classes, in facts, have a method named size() that makes impossible for a class to both derive JPanel and extend Collection.
Since this is needed for JGraph, I created this class that simply renames the Collection size() method into getCollectionSize() leaving everything else unchanged. This is what CompatibleCollection basically does.
There's also a companion wrapper that does the opposite to achieve maximum compatibility.

Version:
2005/10/5
Author:
Silvio Moioli

Constructor Summary
CollectionToCompatibleWrapper(java.util.Collection wrapped)
          Standard constructor, wraps a Collection.
 
Method Summary
 boolean add(java.lang.Object arg0)
          Ensures that this collection contains the specified element (optional operation).
 boolean addAll(java.util.Collection arg0)
          Adds all of the elements in the specified collection to this collection (optional operation).
 void clear()
          Removes all of the elements from this collection (optional operation).
 boolean contains(java.lang.Object arg0)
          Returns true if this collection contains the specified element.
 boolean containsAll(java.util.Collection arg0)
          Returns true if this collection contains all of the elements in the specified collection.
 int getCollectionSize()
          Renames the size() method, returns the number of elements in the wrapped Collection.
 boolean isEmpty()
          Returns true if this collection contains no elements.
 java.util.Iterator iterator()
          Returns an iterator over the elements in this collection.
 boolean remove(java.lang.Object arg0)
          Removes a single instance of the specified element from this collection, if it is present (optional operation).
 boolean removeAll(java.util.Collection arg0)
          Removes all this collection's elements that are also contained in the specified collection (optional operation).
 boolean retainAll(java.util.Collection arg0)
          Retains only the elements in this collection that are contained in the specified collection (optional operation).
 java.lang.Object[] toArray()
          Returns an array containing all of the elements in this collection.
 java.lang.Object[] toArray(java.lang.Object[] arg0)
          Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.moioli.chart.swing.CompatibleCollection
equals, hashCode
 

Constructor Detail

CollectionToCompatibleWrapper

public CollectionToCompatibleWrapper(java.util.Collection wrapped)
Standard constructor, wraps a Collection.

Parameters:
wrapped - the Collection to be wrapped
Method Detail

getCollectionSize

public int getCollectionSize()
Renames the size() method, returns the number of elements in the wrapped Collection.

Specified by:
getCollectionSize in interface CompatibleCollection
Returns:
the number of elements

add

public boolean add(java.lang.Object arg0)
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.

Specified by:
add in interface CompatibleCollection
Parameters:
arg0 - element whose presence in this collection is to be ensured.
Returns:
true if this collection changed as a result of the call
Throws:
java.lang.UnsupportedOperationException - add is not supported by this collection.
java.lang.ClassCastException - class of the specified element prevents it from being added to this collection.
java.lang.NullPointerException - if the specified element is null and this collection does not support null elements.
java.lang.IllegalArgumentException - some aspect of this element prevents it from being added to this collection.

addAll

public boolean addAll(java.util.Collection arg0)
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.)

Specified by:
addAll in interface CompatibleCollection
Parameters:
arg0 - elements to be inserted into this collection.
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.
java.lang.ClassCastException - if the class of an element of the specified collection prevents it from being added to this collection.
java.lang.NullPointerException - if the specified collection contains one or more null elements and this collection does not support null elements, or if the specified collection is null.
java.lang.IllegalArgumentException - some aspect of an element of the specified collection prevents it from being added to this collection.
See Also:
add(Object)

clear

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

Specified by:
clear in interface CompatibleCollection
Throws:
java.lang.UnsupportedOperationException - if the clear method is not supported by this collection.

contains

public boolean contains(java.lang.Object arg0)
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)).

Specified by:
contains in interface CompatibleCollection
Parameters:
arg0 - element whose presence in this collection is to be tested.
Returns:
true if this collection contains the specified element
Throws:
java.lang.ClassCastException - if the type of the specified element is incompatible with this collection (optional).
java.lang.NullPointerException - if the specified element is null and this collection does not support null elements (optional).

containsAll

public boolean containsAll(java.util.Collection arg0)
Returns true if this collection contains all of the elements in the specified collection.

Specified by:
containsAll in interface CompatibleCollection
Parameters:
arg0 - collection to be checked for containment in this collection.
Returns:
true if this collection contains all of the elements in the specified collection
Throws:
java.lang.ClassCastException - if the types of one or more elements in the specified collection are incompatible with this collection (optional).
java.lang.NullPointerException - if the specified collection contains one or more null elements and this collection does not support null elements (optional).
java.lang.NullPointerException - if the specified collection is null.
See Also:
contains(Object)

isEmpty

public boolean isEmpty()
Returns true if this collection contains no elements.

Specified by:
isEmpty in interface CompatibleCollection
Returns:
true if this collection contains no elements

iterator

public java.util.Iterator iterator()
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).

Specified by:
iterator in interface CompatibleCollection
Returns:
an Iterator over the elements in this collection

remove

public boolean remove(java.lang.Object arg0)
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).

Specified by:
remove in interface CompatibleCollection
Parameters:
arg0 - element to be removed from this collection, if present.
Returns:
true if this collection changed as a result of the call
Throws:
java.lang.ClassCastException - if the type of the specified element is incompatible with this collection (optional).
java.lang.NullPointerException - if the specified element is null and this collection does not support null elements (optional).
java.lang.UnsupportedOperationException - remove is not supported by this collection.

removeAll

public boolean removeAll(java.util.Collection arg0)
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.

Specified by:
removeAll in interface CompatibleCollection
Parameters:
arg0 - elements to be removed from this collection.
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.
java.lang.ClassCastException - if the types of one or more elements in this collection are incompatible with the specified collection (optional).
java.lang.NullPointerException - if this collection contains one or more null elements and the specified collection does not support null elements (optional).
java.lang.NullPointerException - if the specified collection is null.
See Also:
remove(Object), contains(Object)

retainAll

public boolean retainAll(java.util.Collection arg0)
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.

Specified by:
retainAll in interface CompatibleCollection
Parameters:
arg0 - elements to be retained in this collection.
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.
java.lang.ClassCastException - if the types of one or more elements in this collection are incompatible with the specified collection (optional).
java.lang.NullPointerException - if this collection contains one or more null elements and the specified collection does not support null elements (optional).
java.lang.NullPointerException - if the specified collection is null.
See Also:
remove(Object), contains(Object)

toArray

public java.lang.Object[] toArray()
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.

Specified by:
toArray in interface CompatibleCollection
Returns:
an array containing all of the elements in this collection

toArray

public java.lang.Object[] toArray(java.lang.Object[] arg0)
Returns an array containing all of the elements in this collection; the runtime type of the returned array 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().

Specified by:
toArray in interface CompatibleCollection
Parameters:
arg0 - 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:
java.lang.ArrayStoreException - the runtime type of the specified array is not a supertype of the runtime type of every element in this collection.
java.lang.NullPointerException - if the specified array is null.