ConverterCollections::ConverterSet Class Reference

#include <coherence/util/ConverterCollections.hpp>

Inherits WrapperCollections::AbstractWrapperSet.

Inherited by MapKeySet.

List of all members.

---

Detailed Description

A ConverterSet views an underlying Set through a Converter.

Public Types
typedef spec::Handle	Handle
	ConverterSet Handle definition.
typedef spec::View	View
	ConverterSet View definition.
typedef spec::Holder	Holder
	ConverterSet Holder definition.
Public Member Functions
virtual bool	contains (Object::View v) const
	Determine if this collection contains the specified element. Parameters: v  the element to test for containment Returns: true iff this collection contains the given element
virtual Iterator::Handle	iterator () const
	Return an Iterator over this collection. Returns: an Iterator over this collection
virtual Muterator::Handle	iterator ()
	Return an Iterator over this collection. Returns: an Iterator over this collection
virtual ObjectArray::Handle	toArray () const
	Return the contents of this collection as an ObjectArray. Returns: a new ObjectArray containing all the elements of this collection in the same order as returned by the collection's Iterator See also: Iterator
virtual bool	add (Object::Holder oh)
	Add the given element to this collection. Parameters: oh  the element to add Returns: true iff this collection was modified as a result of this operation
virtual bool	remove (Object::View v)
	Remove the supplied element from this collection. Parameters: v  the element to remove Returns: true iff this collection was modified as a result of this operation
virtual bool	containsAll (Collection::View vc) const
	Determine if this collection contains all elements from the supplied collection. Parameters: vCol  the collection of elements to test for containment Returns: true iff this collection contains all elements from the supplied collection Exceptions: coherence::lang::NullPointerException  if the specified collection is NULL See also: contains()
virtual bool	addAll (Collection::View vc)
	Add all elements from the supplied collection to this collection. Parameters: vCol  the collection of elements to add Returns: true iff this collection was modified as a result of this operation Exceptions: coherence::lang::NullPointerException  if the specified collection is NULL See also: add()
virtual bool	removeAll (Collection::View vc)
	Remove all instances of the elements in the supplied collection from this collection. Upon completion, contains() on this collection will return false for all elements in the supplied collection. Parameters: vCol  the collection of elements to remove Returns: true iff this collection was modified as a result of this operation Exceptions: coherence::lang::NullPointerException  if the specified collection is NULL See also: remove() contains()
virtual bool	retainAll (Collection::View vc)
	Remove all elements from this collection that are not present in the supplied collection. Parameters: vCol  the collection of elements to retain Returns: true iff this collection was modified as a result of this operation. Exceptions: coherence::lang::NullPointerException  if the specified collection is NULL See also: remove() contains()
virtual bool	equals (Object::View that) const
	Compare the specified object with this set for equality. Return true if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals() method works properly across different implementations of the Set interface. Parameters: v  Object to be compared for equality with this set. Returns: true iff the specified Object is equal to this set.
virtual void	toStream (std::ostream &out) const
	Output a human-readable description of this Object to the given stream. coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toStream method, to output Objects. If a manged String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents. Object::View vKey = ... Object::View vValue = ... std::cout << vKey << " = " << vValue << std::endl; String::Handle hs = COH_TO_STRING(vKey << " = " << vValue); Parameters: out  the stream used to output the description
Protected Member Functions
	ConverterSet (Set::Handle hsetDelegate, Converter::View vConvUp, Converter::View vConvDown)
	Create a WrapperCollections::AbstractWrapperSet which delegates to the specified Set.
	ConverterSet (Set::View vsetDelegate, Converter::View vConvUp, Converter::View vConvDown)
	Create a WrapperCollections::AbstractWrapperSet which delegates to the specified Set.
	ConverterSet (const ConverterSet &that)
	Copy constructor.
Protected Attributes
const Converter::View	m_vConvUp
	The Converter from the underlying Set.
const Converter::View	m_vConvDown
	The Converter to the underlying Set.

---

Constructor & Destructor Documentation

ConverterSet	(	Set::Handle	hsetDelegate,
		Converter::View	vConvUp,
		Converter::View	vConvDown
	)			[protected]

Create a WrapperCollections::AbstractWrapperSet which delegates to the specified Set.

Parameters:

	hSet	the specified Set
	vConvUp	the Converter from the underlying Set
	vConvDown	the Converter to the underlying Set

ConverterSet	(	Set::View	vsetDelegate,
		Converter::View	vConvUp,
		Converter::View	vConvDown
	)			[protected]

Create a WrapperCollections::AbstractWrapperSet which delegates to the specified Set.

Parameters:

	vSet	the specified Set
	vConvUp	the Converter from the underlying Set
	vConvDown	the Converter to the underlying Set

---

The documentation for this class was generated from the following file:

• coherence/util/ConverterCollections.hpp

Copyright (c) 2000-2008 Oracle. All rights reserved.