Overview | Package | Class | Tree | Index | Help

Oracle® Coherence Java API Reference
v3.5.3
E15583-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.tangosol.util
Class RestrictedCollections.RestrictedEntrySet

    java.lang.Object
      com.tangosol.util.Base
          com.tangosol.util.RestrictedCollections.RestrictedEntrySet

All Implemented Interfaces:
  java.io.Serializable, java.lang.Iterable, java.util.Collection, java.util.Set

Enclosing class:
  RestrictedCollections

    public static class RestrictedCollections.RestrictedEntrySet

extends Base
implements java.util.Set, java.io.Serializable

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

Nested Class Summary
`protected class` | `RestrictedCollections.RestrictedEntrySet.RestrictedEntry` A Map Entry that restricts the key and value types.
`protected class` | `RestrictedCollections.RestrictedEntrySet.RestrictedIterator` A Map Entry Iterator that restricts the key and value types.

Field Summary
`protected java.lang.Class` | `m_clzVal` The class of value stored in the Map.
`protected java.util.Set` | `m_set` The underlying Entry Set.

Constructor Summary
`RestrictedCollections.RestrictedEntrySet(java.util.Set set, java.lang.Class clzKey, java.lang.Class clzVal)` 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` | `checkValue(java.lang.Object o)` Check the passed object to verify that it passes the "value" restriction of this Map.
`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.
`protected java.util.Map.Entry` | `wrapEntry(java.util.Map.Entry entry)` Wrap an Entry from the Entry Set to make a Restricted Entry.
`protected java.util.Iterator` | `wrapIterator(java.util.Iterator iter)` Wrap an Iterator from the Entry Set to make a Restricted Iterator.

Field Detail

### m_set

    protected java.util.Set m_set

  The underlying Entry Set.

### m_clzVal

    protected java.lang.Class m_clzVal

  The class of value stored in the Map.

Constructor Detail

### RestrictedCollections.RestrictedEntrySet

    public RestrictedCollections.RestrictedEntrySet(java.util.Set set,
                                                    java.lang.Class clzKey,
                                                    java.lang.Class clzVal)

  Constructor.

  Parameters:
    `set` - the underlying Entry Set
    `clzKey` - the class of keys that may be stored in the Map
    `clzVal` - the class of values that may be stored in the Map

Method Detail

### size

    public int size()

  Returns the number of elements in this Collection.

  Specified by:
    `size` in interface `java.util.Collection`
  Specified by:
    `size` in interface `java.util.Set`
  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`
  Specified by:
    `isEmpty` in interface `java.util.Set`
  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`
  Specified by:
    `contains` in interface `java.util.Set`
  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`
  Specified by:
    `iterator` in interface `java.util.Set`
  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`
  Specified by:
    `toArray` in interface `java.util.Set`
  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`
  Specified by:
    `toArray` in interface `java.util.Set`
  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`
  Specified by:
    `add` in interface `java.util.Set`
  Parameters:
    `o` - element whose presence in this Collection is to be ensured
  Returns:
    true if the Collection changed as a result of the call

### 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`
  Specified by:
    `remove` in interface `java.util.Set`
  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`
  Specified by:
    `containsAll` in interface `java.util.Set`
  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

### 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`
  Specified by:
    `addAll` in interface `java.util.Set`
  Parameters:
    `col` - elements to be inserted into this Collection
  Returns:
    `true` if this Collection changed as a result of the call

### 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`
  Specified by:
    `removeAll` in interface `java.util.Set`
  Parameters:
    `col` - elements to be removed from this Collection
  Returns:
    `true` if this Collection changed as a result of the call

### 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`
  Specified by:
    `retainAll` in interface `java.util.Set`
  Parameters:
    `col` - elements to be retained in this Collection
  Returns:
    `true` if this Collection changed as a result of the call

### clear

    public void clear()

  Removes all of the elements from this Collection.

  Specified by:
    `clear` in interface `java.util.Collection`
  Specified by:
    `clear` in interface `java.util.Set`

### 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`
  Specified by:
    `equals` in interface `java.util.Set`
  Parameters:
    `o` - Object to be compared for equality with this Collection
  Returns:
    `true` if the specified object is equal to this Collection

### 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`
  Specified by:
    `hashCode` in interface `java.util.Set`
  Returns:
    the hash code value for this collection

### toString

    public java.lang.String toString()

  Return a String description for this collection.

  Returns:
    a String description of the Collection

### checkValue

    protected void checkValue(java.lang.Object o)

  Check the passed object to verify that it passes the "value" restriction of this Map.

  Parameters:
    `o` - the Object to check
  Throws:
    `java.lang.ClassCastException` - if the class of the passed Object prevents it from being used as a value in this Map

### wrapEntry

    protected java.util.Map.Entry wrapEntry(java.util.Map.Entry entry)

  Wrap an Entry from the Entry Set to make a Restricted Entry.

  Parameters:
    `entry` - a Map Entry to wrap
  Returns:
    a Map Entry that restricts its type

### wrapIterator

    protected java.util.Iterator wrapIterator(java.util.Iterator iter)

  Wrap an Iterator from the Entry Set to make a Restricted Iterator.

  Parameters:
    `iter` - a Iterator to wrap
  Returns:
    a Restricted Iterator

Overview | Package | Class | Tree | Index | Help

Oracle® Coherence Java API Reference
v3.5.3
E15583-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000, 2010, Oracle. All rights reserved.