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.net.cache
Class ReadWriteBackingMap.KeySet

    java.lang.Object
      java.util.AbstractCollection
          java.util.AbstractSet
              com.tangosol.net.cache.ReadWriteBackingMap.KeySet

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

Enclosing class:
  ReadWriteBackingMap

    protected class ReadWriteBackingMap.KeySet

extends java.util.AbstractSet

A set of entries backed by this backing map.

Constructor Summary
`protected` | `ReadWriteBackingMap.KeySet()`

Method Summary
`void` | `clear()` Removes all of the elements from this set of Keys by clearing the underlying Map.
`boolean` | `contains(java.lang.Object oKey)` Determine if a particular key is present in the Set.
`java.util.Iterator` | `iterator()` Returns an iterator over the elements contained in this collection.
`boolean` | `remove(java.lang.Object o)` Removes the specified element from this Set of keys if it is present by removing the associated entry from the underlying Map.
`int` | `size()` Determine the number of keys in the Set.
`java.lang.Object[]` | `toArray()` Returns an array containing all of the keys in this set.
`java.lang.Object[]` | `toArray(java.lang.Object[] ao)` Returns an array with a runtime type is that of the specified array and that contains all of the keys in this Set.

Methods inherited from class java.util.AbstractSet
`equals, hashCode, removeAll`

Methods inherited from class java.util.AbstractCollection
`add, addAll, containsAll, isEmpty, retainAll, toString`

Methods inherited from interface java.util.Set
`add, addAll, containsAll, isEmpty, retainAll`

Constructor Detail

### ReadWriteBackingMap.KeySet

    protected ReadWriteBackingMap.KeySet()

Method Detail

### 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`
  Specified by:
    `iterator` in class `java.util.AbstractCollection`
  Returns:
    an iterator over the elements contained in this collection

### size

    public int size()

  Determine the number of keys in the Set.

  Specified by:
    `size` in interface `java.util.Collection`
  Specified by:
    `size` in interface `java.util.Set`
  Specified by:
    `size` in class `java.util.AbstractCollection`
  Returns:
    the number of keys in the Set, which is the same as the number of entries in the underlying Map

### contains

    public boolean contains(java.lang.Object oKey)

  Determine if a particular key is present in the Set.

  Specified by:
    `contains` in interface `java.util.Collection`
  Specified by:
    `contains` in interface `java.util.Set`
  Overrides:
    `contains` in class `java.util.AbstractCollection`
  Returns:
    true iff the passed key object is in the key Set

### remove

    public boolean remove(java.lang.Object o)

  Removes the specified element from this Set of keys if it is present by removing the associated entry from the underlying Map.

  Specified by:
    `remove` in interface `java.util.Collection`
  Specified by:
    `remove` in interface `java.util.Set`
  Overrides:
    `remove` in class `java.util.AbstractCollection`
  Parameters:
    `o` - object to be removed from this set, if present
  Returns:
    true if the set contained the specified element

### clear

    public void clear()

  Removes all of the elements from this set of Keys by clearing the underlying Map.

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

### toArray

    public java.lang.Object[] toArray()

  Returns an array containing all of the keys in this set.

  Specified by:
    `toArray` in interface `java.util.Collection`
  Specified by:
    `toArray` in interface `java.util.Set`
  Overrides:
    `toArray` in class `java.util.AbstractCollection`
  Returns:
    an array containing all of the keys in this set

### toArray

    public java.lang.Object[] toArray(java.lang.Object[] ao)

  Returns an array with a runtime type is that of the specified array and that contains all of the keys in this Set. If the Set 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 the Set fits in the specified array with room to spare (i.e., the array has more elements than the Set), the element in the array immediately following the end of the Set is set to `null`. This is useful in determining the length of the Set only if the caller knows that the Set does not contain any `null` keys.)

  Specified by:
    `toArray` in interface `java.util.Collection`
  Specified by:
    `toArray` in interface `java.util.Set`
  Overrides:
    `toArray` in class `java.util.AbstractCollection`
  Parameters:
    `ao` - the array into which the elements of the Set 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 the Set
  Throws:
    `java.lang.ArrayStoreException` - if the runtime type of the specified array is not a supertype of the runtime type of every element in this Set of keys

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.