Class ModifiableCollection
- java.lang.Object
-
- com.globalmentor.beans.BoundPropertyObject
-
- com.globalmentor.model.DefaultModifiable
-
- com.globalmentor.collections.ModifiableCollection
-
- All Implemented Interfaces:
PropertyBindable
,PropertyConstrainable
,Modifiable
,java.lang.Iterable
,java.util.Collection
- Direct Known Subclasses:
ModifiableSet
public class ModifiableCollection extends DefaultModifiable implements java.util.Collection
Deprecated.A collection that implementsModifiable
so that it can keep track of whether it has been modified.This class is meant as a wrapper to an existing collection.
- Author:
- Garret Wilson
- See Also:
Modifiable
-
-
Field Summary
-
Fields inherited from class com.globalmentor.beans.BoundPropertyObject
NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS
-
Fields inherited from interface com.globalmentor.model.Modifiable
MODIFIED_PROPERTY
-
-
Constructor Summary
Constructors Constructor Description ModifiableCollection(java.util.Collection collection)
Deprecated.Collection constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
add(java.lang.Object o)
Deprecated.Ensures that this collection contains the specified element (optional operation).boolean
addAll(java.util.Collection c)
Deprecated.Adds all of the elements in the specified collection to this collection (optional operation).void
clear()
Deprecated.Removes all of the elements from this collection (optional operation).boolean
contains(java.lang.Object o)
Deprecated.Returnstrue
if this collection contains the specified element.boolean
containsAll(java.util.Collection c)
Deprecated.Returnstrue
if this collection contains all of the elements in the specified collection.boolean
equals(java.lang.Object o)
Deprecated.Compares the specified object with this collection for equality.int
hashCode()
Deprecated.Returns the hash code value for this collection.boolean
isEmpty()
Deprecated.Returnstrue
if this collection contains no elements.java.util.Iterator
iterator()
Deprecated.Returns an iterator over the elements in this collection.boolean
remove(java.lang.Object o)
Deprecated.Removes a single instance of the specified element from this collection, if it is present (optional operation).boolean
removeAll(java.util.Collection c)
Deprecated.Removes all this collection's elements that are also contained in the specified collection (optional operation).boolean
retainAll(java.util.Collection c)
Deprecated.Retains only the elements in this collection that are contained in the specified collection (optional operation).int
size()
Deprecated.Returns the number of elements in this collection.java.lang.Object[]
toArray()
Deprecated.Returns an array containing all of the elements in this collection.java.lang.Object[]
toArray(java.lang.Object[] a)
Deprecated.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 com.globalmentor.model.DefaultModifiable
isModified, setModified
-
Methods inherited from class com.globalmentor.beans.BoundPropertyObject
addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, createPostponedPropertyChangeEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getForwardPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getRepeatPropertyChangeListener, getRepeatVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, getVetoableChangeSupport, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
Method Detail
-
size
public int size()
Deprecated.Returns the number of elements in this collection. If this collection contains more thanInteger.MAX_VALUE
elements, returnsInteger.MAX_VALUE
.- Specified by:
size
in interfacejava.util.Collection
- Returns:
- the number of elements in this collection
-
isEmpty
public boolean isEmpty()
Deprecated.Returnstrue
if this collection contains no elements.- Specified by:
isEmpty
in interfacejava.util.Collection
- Returns:
true
if this collection contains no elements
-
contains
public boolean contains(java.lang.Object o)
Deprecated.Returnstrue
if this collection contains the specified element. More formally, returnstrue
if and only if this collection contains at least one elemente
such that(o==null ? e==null : o.equals(e))
.- Specified by:
contains
in interfacejava.util.Collection
- Parameters:
o
- 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).
-
iterator
public java.util.Iterator iterator()
Deprecated.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 interfacejava.util.Collection
- Specified by:
iterator
in interfacejava.lang.Iterable
- Returns:
- an
Iterator
over the elements in this collection
-
toArray
public java.lang.Object[] toArray()
Deprecated.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 interfacejava.util.Collection
- Returns:
- an array containing all of the elements in this collection
-
toArray
public java.lang.Object[] toArray(java.lang.Object[] a)
Deprecated.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 anynull
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 costsSuppose
l
is aList
known to contain only strings. The following code can be used to dump the list into a newly allocated array ofString
:String[] x = (String[])v.toArray(new String[0]);
Note that
toArray(new Object[0])
is identical in function totoArray()
.- Specified by:
toArray
in interfacejava.util.Collection
- Parameters:
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:
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 isnull
.
-
add
public boolean add(java.lang.Object o)
Deprecated.Ensures that this collection contains the specified element (optional operation). Returnstrue
if this collection changed as a result of the call. (Returnsfalse
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 interfacejava.util.Collection
- Parameters:
o
- 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.
-
remove
public boolean remove(java.lang.Object o)
Deprecated.Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an elemente
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 interfacejava.util.Collection
- Parameters:
o
- 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.
-
containsAll
public boolean containsAll(java.util.Collection c)
Deprecated.Returnstrue
if this collection contains all of the elements in the specified collection.- Specified by:
containsAll
in interfacejava.util.Collection
- Parameters:
c
- 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 isnull
.- See Also:
contains(Object)
-
addAll
public boolean addAll(java.util.Collection c)
Deprecated.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 interfacejava.util.Collection
- Parameters:
c
- 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 theaddAll
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 isnull
.java.lang.IllegalArgumentException
- some aspect of an element of the specified collection prevents it from being added to this collection.- See Also:
add(Object)
-
removeAll
public boolean removeAll(java.util.Collection c)
Deprecated.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 interfacejava.util.Collection
- Parameters:
c
- elements to be removed from this collection.- Returns:
true
if this collection changed as a result of the call- Throws:
java.lang.UnsupportedOperationException
- if theremoveAll
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 isnull
.- See Also:
remove(Object)
,contains(Object)
-
retainAll
public boolean retainAll(java.util.Collection c)
Deprecated.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 interfacejava.util.Collection
- Parameters:
c
- elements to be retained in this collection.- Returns:
true
if this collection changed as a result of the call- Throws:
java.lang.UnsupportedOperationException
- if theretainAll
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 isnull
.- See Also:
remove(Object)
,contains(Object)
-
clear
public void clear()
Deprecated.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 interfacejava.util.Collection
- Throws:
java.lang.UnsupportedOperationException
- if theclear
method is not supported by this collection.
-
equals
public boolean equals(java.lang.Object o)
Deprecated.Compares the specified object with this collection for equality.While the
Collection
interface adds no stipulations to the general contract for theObject.equals
, programmers who implement theCollection
interface "directly" (in other words, create a class that is aCollection
but is not aSet
or aList
) must exercise care if they choose to override theObject.equals
. It is not necessary to do so, and the simplest course of action is to rely onObject
's implementation, but the implementer may wish to implement a "value comparison" in place of the default "reference comparison." (TheList
andSet
interfaces mandate such value comparisons.)The general contract for the
Object.equals
method states that equals must be symmetric (in other words,a.equals(b)
if and only ifb.equals(a)
). The contracts forList.equals
andSet.equals
state that lists are only equal to other lists, and sets to other sets. Thus, a customequals
method for a collection class that implements neither theList
norSet
interface must returnfalse
when this collection is compared to any list or set. (By the same logic, it is not possible to write a class that correctly implements both theSet
andList
interfaces.)- Specified by:
equals
in interfacejava.util.Collection
- Overrides:
equals
in classjava.lang.Object
- Parameters:
o
- Object to be compared for equality with this collection.- Returns:
true
if the specified object is equal to this collection- See Also:
Object.equals(Object)
,Set.equals(Object)
,List.equals(Object)
-
hashCode
public int hashCode()
Deprecated.Returns the hash code value for this collection. While theCollection
interface adds no stipulations to the general contract for theObject.hashCode
method, programmers should take note that any class that overrides theObject.equals
method must also override theObject.hashCode
method in order to satisfy the general contract for theObject.hashCode
method. In particular,c1.equals(c2)
implies thatc1.hashCode()==c2.hashCode()
.- Specified by:
hashCode
in interfacejava.util.Collection
- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- the hash code value for this collection
- See Also:
Object.hashCode()
,Object.equals(Object)
-
-