Skip navigation links

Oracle® Coherence Java API Reference
Release 3.7.0.0

E18683-01


com.tangosol.util
Class RestrictedCollections.RestrictedCollection

java.lang.Object
  extended by com.tangosol.util.Base
      extended by com.tangosol.util.RestrictedCollections.RestrictedCollection

All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable, java.util.Collection
Direct Known Subclasses:
RestrictedCollections.RestrictedList, RestrictedCollections.RestrictedSet
Enclosing class:
RestrictedCollections

public static class RestrictedCollections.RestrictedCollection
extends Base
implements java.util.Collection, java.io.Serializable

A restricted Collection that requires its contents to be of a specified class.


Field Summary
protected  java.lang.Class m_clz
          The class of Objects stored in the Collection.
protected  java.util.Collection m_col
          The underlying Collection.

 

Constructor Summary
RestrictedCollections.RestrictedCollection(java.util.Collection col, java.lang.Class clz)
          Constructor.

 

Method Summary
 boolean add(java.lang.Object o)
          Ensures that this Collection contains the specified element.
 boolean addAll(java.util.Collection col)
          Adds all of the elements in the specified Collection to this Collection (optional operation).
protected  void checkObject(java.lang.Object o)
          Check the passed object to verify that it passes the restriction of this Collection.
 void clear()
          Removes all of the elements from this Collection.
 boolean contains(java.lang.Object o)
          Returns true if this Collection contains the specified element.
 boolean containsAll(java.util.Collection col)
          Returns true if this Collection contains all of the elements in the specified Collection.
 boolean equals(java.lang.Object o)
          Compares the specified object with this collection for equality.
 int hashCode()
          Returns the hash code value for this collection.
 boolean isEmpty()
          Returns true if this Collection contains no elements.
 java.util.Iterator iterator()
          Returns an Iterator over the elements contained in this Collection.
 boolean remove(java.lang.Object o)
          Removes a single instance of the specified element from this Collection, if it is present (optional operation).
 boolean removeAll(java.util.Collection col)
          Removes all this Collection's elements that are also contained in the specified Collection (optional operation).
 boolean retainAll(java.util.Collection col)
          Retains only the elements in this Collection that are contained in the specified Collection (optional operation).
 int size()
          Returns the number of elements in this Collection.
 java.lang.Object[] toArray()
          Returns an array containing all of the elements in this Collection.
 java.lang.Object[] toArray(java.lang.Object[] ao)
          Returns an array containing all of the elements in this Collection whose runtime type is that of the specified array.
 java.lang.String toString()
          Return a String description for this collection.

 

Field Detail

m_col

protected java.util.Collection m_col
The underlying Collection.

m_clz

protected java.lang.Class m_clz
The class of Objects stored in the Collection.

Constructor Detail

RestrictedCollections.RestrictedCollection

public RestrictedCollections.RestrictedCollection(java.util.Collection col,
                                                  java.lang.Class clz)
Constructor.
Parameters:
col - the underlying Collection
clz - the class of objects that may be stored in the Collection

Method Detail

size

public int size()
Returns the number of elements in this Collection.
Specified by:
size in interface java.util.Collection
Returns:
the number of elements in this Collection

isEmpty

public boolean isEmpty()
Returns true if this Collection contains no elements.
Specified by:
isEmpty in interface java.util.Collection
Returns:
true if this Collection contains no elements

contains

public boolean contains(java.lang.Object o)
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 java.util.Collection
Parameters:
o - the object to search for in the Collection
Returns:
true if this Collection contains the specified object

iterator

public java.util.Iterator iterator()
Returns an Iterator over the elements contained in this Collection.
Specified by:
iterator in interface java.lang.Iterable
Specified by:
iterator in interface java.util.Collection
Returns:
an Iterator over the elements contained in this Collection

toArray

public java.lang.Object[] toArray()
Returns an array containing all of the elements in this Collection. Obeys the general contract of Collection.toArray.
Specified by:
toArray in interface java.util.Collection
Returns:
an array, whose component type is the class of objects that may be stored in the Collection containing all of the elements in this Collection

toArray

public java.lang.Object[] toArray(java.lang.Object[] ao)
Returns an array containing all of the elements in this Collection whose runtime type is that of the specified array. Obeys the general contract of Collection.toArray.
Specified by:
toArray in interface java.util.Collection
Parameters:
ao - 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

add

public boolean add(java.lang.Object o)
Ensures that this Collection contains the specified element.
Specified by:
add in interface java.util.Collection
Parameters:
o - element whose presence in this Collection is to be ensured
Returns:
true if the Collection changed as a result of the call
Throws:
java.lang.ClassCastException - class of the specified element prevents it from being added to this Collection

remove

public boolean remove(java.lang.Object o)
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 the Collection contains one or more such elements. Returns true if the Collection contained the specified element (or equivalently, if the Collection changed as a result of the call).
Specified by:
remove in interface java.util.Collection
Parameters:
o - element to be removed from this Collection, if present
Returns:
true if the Collection contained the specified element

containsAll

public boolean containsAll(java.util.Collection col)
Returns true if this Collection contains all of the elements in the specified Collection.
Specified by:
containsAll in interface java.util.Collection
Parameters:
col - Collection to be checked for containment in this Collection
Returns:
true if this Collection contains all of the elements in the specified Collection
See Also:
Collection.contains(Object)

addAll

public boolean addAll(java.util.Collection col)
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 java.util.Collection
Parameters:
col - elements to be inserted into this Collection
Returns:
true if this Collection changed as a result of the call
Throws:
java.lang.ClassCastException - if the class of an element of the specified Collection prevents it from being added to this Collection
See Also:
Collection.add(Object)

removeAll

public boolean removeAll(java.util.Collection col)
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 java.util.Collection
Parameters:
col - elements to be removed from this Collection
Returns:
true if this Collection changed as a result of the call
See Also:
Collection.remove(Object), Collection.contains(Object)

retainAll

public boolean retainAll(java.util.Collection col)
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 java.util.Collection
Parameters:
col - elements to be retained in this Collection
Returns:
true if this Collection changed as a result of the call
See Also:
Collection.remove(Object), Collection.contains(Object)

clear

public void clear()
Removes all of the elements from this Collection.
Specified by:
clear in interface java.util.Collection

equals

public boolean equals(java.lang.Object o)
Compares the specified object with this collection for equality.

Obeys the general contract of Collection.equals.

Specified by:
equals in interface java.util.Collection
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()
Returns the hash code value for this collection. Obeys the general contract of Collection.hashCode.
Specified by:
hashCode in interface java.util.Collection
Returns:
the hash code value for this collection
See Also:
Object.hashCode(), Object.equals(Object)

toString

public java.lang.String toString()
Return a String description for this collection.
Returns:
a String description of the Collection

checkObject

protected void checkObject(java.lang.Object o)
Check the passed object to verify that it passes the restriction of this Collection.
Parameters:
o - the Object to check
Throws:
java.lang.ClassCastException - if the class of the passed Object prevents it from being stored in this Collection

Skip navigation links

Oracle® Coherence Java API Reference
Release 3.7.0.0

E18683-01


Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.