Oracle® Fusion Middleware C++ API Reference for Oracle Coherence: ConverterCollections::ConverterCollection Class Reference

If this collection fits in the array with additional room then the element in the array immediately following the end of the collection is set to NULL. This can be useful in determining the length of this collection if the caller knows that the collection does not contain any NULL elements.

Parameters:

hao

an array in which to store the collection's contents

Returns:: a ObjectArray containing all the elements of the 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:

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:

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

virtual size32_t

hashCode () const

Return a hash code value for the Object.

This method is supported for the benefit of hash-based containers.

The general contract of hashCode is:

Whenever it is invoked on the same Object more than once during an execution of an application, the hashCode method must consistently return the same value, provided no information used in equals comparisons on the object is modified. This value need not remain consistent from one execution of an application to another execution of the same application.
If two Objects are equal according to the equals method, then calling the hashCode method on each of the two Objects must produce the same value.
It is not required that if two Objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct results. However, the programmer should be aware that producing distinct results for unequal objects may improve the performance of hash-based containers.

The default implementation is identity based.

Returns:: a hash code value for this Object

virtual TypedHandle
< const String >

toString () const

Output a human-readable description of this Object to the given stream.

Note that when overriding this method the return type must be TypedHandle<const String> rather then String::View. These two types are assignment compatible but not equivalent and declaring the override with String::View will not be a compatible override.

coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toString method, to output Objects. If a managed String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents and is generally how toString() will be implemented.

 Object::View vKey   = ...
 Object::View vValue = ...
 std::cout << vKey << " = " << vValue << std::endl;

 String::View vs = COH_TO_STRING(vKey << " = " << vValue);

The COH_TO_STRING macro is also the most common way to implement the toString method. For example:

 virtual TypedHandle<const String> Person::toString() const
     {
     return COH_TO_STRING("Name: " << f_sName << " SSN: " << f_nSSN);
     }

Returns:: a string representation of this object

Protected Member Functions

ConverterCollection (Collection::Handle hcollDelegate, Converter::View vConvUp, Converter::View vConvDown)

Create a WrapperCollections::AbstractWrapperCollection which delegates to the specified Collection.

ConverterCollection (Collection::View vcollDelegate, Converter::View vConvUp, Converter::View vConvDown)

Create a WrapperCollections::AbstractWrapperCollection which delegates to the specified Collection.

ConverterCollection (const ConverterCollection &that)

Copy constructor.

Protected Attributes

FinalView< Converter >

f_vConvUp

The Converter from the underlying container.

FinalView< Converter >

f_vConvDown

The Converter to the underlying container.

Constructor & Destructor Documentation

ConverterCollection	(	Collection::Handle	hcollDelegate,
		Converter::View	vConvUp,
		Converter::View	vConvDown
	)			`[protected]`

Create a WrapperCollections::AbstractWrapperCollection which delegates to the specified Collection.

Parameters:

	hcollDelegate	the specified collection
	vConvUp	the converter from the underlying Collection
	vConvDown	the converter to the underlying Collection

ConverterCollection	(	Collection::View	vcollDelegate,
		Converter::View	vConvUp,
		Converter::View	vConvDown
	)			`[protected]`

Create a WrapperCollections::AbstractWrapperCollection which delegates to the specified Collection.

Parameters:

	vcollDelegate	the specified collection
	vConvUp	the converter from the underlying Collection
	vConvDown	the converter to the underlying Collection