#include <coherence/util/WrapperCollections.hpp>
Inherited by ReadOnlyMultiList::ListView, and TypedCollections::TypedList.
Public Types | ||||||||||
| typedef spec::Handle | Handle | |||||||||
| AbstractWrapperList Handle definition. | ||||||||||
| typedef spec::View | View | |||||||||
| AbstractWrapperList View definition. | ||||||||||
| typedef spec::Holder | Holder | |||||||||
| AbstractWrapperList Holder definition. | ||||||||||
Public Member Functions | ||||||||||
| virtual bool | add (size32_t i, Object::Holder oh) | |||||||||
| Add the given element to this collection at the position specified. If an element is already at that position it will be shifted to the right by 1.
| ||||||||||
| virtual bool | addAll (size32_t i, Collection::View vc) | |||||||||
| Add all the elements from the supplied collection to this collection at the position specified.
| ||||||||||
| virtual Object::Holder | get (size32_t i) const | |||||||||
| Return the element from the specified position in the list.
| ||||||||||
| virtual Object::Holder | get (size32_t i) | |||||||||
| Return the element from the specified position in the list.
| ||||||||||
| virtual size32_t | indexOf (Object::View v) const | |||||||||
| Return the position in the list of the first instance of the specified element.
| ||||||||||
| virtual size32_t | lastIndexOf (Object::View v) const | |||||||||
| Return the position in this list of the last instance of the specified element.
| ||||||||||
|
virtual ListIterator::Handle | listIterator () const | |||||||||
|
virtual ListIterator::Handle | listIterator (size32_t index) const | |||||||||
| Return a ListIterator for this list starting at index.
| ||||||||||
|
virtual ListMuterator::Handle | listIterator () | |||||||||
|
virtual ListMuterator::Handle | listIterator (size32_t index) | |||||||||
| Return a ListIterator for this list starting at index.
| ||||||||||
| virtual Object::Holder | remove (size32_t idx) | |||||||||
| Remove the element at the specified position in the list.
| ||||||||||
| virtual Object::Holder | set (size32_t idx, Object::Holder oh) | |||||||||
| Replace the element at the specified position in this list with the specified element.
| ||||||||||
| virtual List::Handle | subList (size32_t fromIndex, size32_t toIndex) | |||||||||
| Return a new list containing the contents of the list between the specified fromIndex (inclusive) and toIndex (exclusive).
| ||||||||||
| virtual List::View | subList (size32_t fromIndex, size32_t toIndex) const | |||||||||
| Return a new list containing the contents of the list between the specified fromIndex (inclusive) and toIndex (exclusive).
| ||||||||||
| virtual size32_t | size () const | |||||||||
| Return the number of elements in this collection.
| ||||||||||
| virtual bool | isEmpty () const | |||||||||
| Determine whether this collection contains any elements.
| ||||||||||
| virtual bool | contains (Object::View v) const | |||||||||
| Determine if this collection contains the specified element.
| ||||||||||
| virtual bool | containsAll (Collection::View vCol) const | |||||||||
| Determine if this collection contains all elements from the supplied collection.
| ||||||||||
| virtual Iterator::Handle | iterator () const | |||||||||
| Return an Iterator over this collection.
| ||||||||||
| virtual Muterator::Handle | iterator () | |||||||||
| Return an Iterator over this collection.
| ||||||||||
|
virtual ObjectArray::Handle | toArray (ObjectArray::Handle hao=NULL) const | |||||||||
| Return the contents of this collection as an ObjectArray. If the collection fits in the specified array, it is returned, otherwise, a new array is allocated that is the size of this collection. 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.
| ||||||||||
| virtual bool | add (Object::Holder oh) | |||||||||
| Add the given element to this collection.
| ||||||||||
| virtual bool | addAll (Collection::View vCol) | |||||||||
| Add all elements from the supplied collection to this collection.
| ||||||||||
| virtual bool | remove (Object::View v) | |||||||||
| Remove the supplied element from this collection.
| ||||||||||
| virtual bool | removeAll (Collection::View vCol) | |||||||||
| 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.
| ||||||||||
| virtual bool | retainAll (Collection::View vCol) | |||||||||
| Remove all elements from this collection that are not present in the supplied collection.
| ||||||||||
| virtual void | clear () | |||||||||
| Remove all elements from this collection. | ||||||||||
|
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); }
| ||||||||||
| 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
The default implementation is identity based.
| ||||||||||
| virtual bool | equals (Object::View v) const | |||||||||
| virtual bool | isImmutable () const | |||||||||
Return true iff no further changes can be made to the Object, that would effect the outcome of a call to its equals method.Except for Objects which are naturally immutable (such as String), being immutable generally implies that the Object is only referenced via const pointers or views. Objects which hold references to child Objects, may need to take the immutability of their children into account when determining their own immutability. This extended check is not performed by the default implementation, but can be integrated into the immutability checks by overriding this method, as well as making use of MemberHandles to reference child Objects. A typical derived implementation may look as follows:
bool isImmutable() const { if (m_fImmutable) // check recorded state { return true; // already marked as immutable, avoid calculation } else if (Object::isImmutable()) // ensure shallow immutability { // ensure deep immutability if (m_child1->isImmutable() && m_child2->isImmutable() ... && m_childN->isImmutable()) { // record and return immutability return m_fImmutable = true; } // some Objects which comprise this Object are still mutable } return false; } The default implementation return true iff the Object is only referenced via const pointers and or views.
| ||||||||||
Protected Member Functions | ||||||||||
| AbstractWrapperList (List::Holder ohListDelegate) | ||||||||||
| Create an AbstractWrapperList which delegates to the specified List. | ||||||||||
| AbstractWrapperList (const AbstractWrapperList &that) | ||||||||||
| Copy constructor. | ||||||||||
| virtual List::Handle | getDelegate () | |||||||||
| Return a handle to the delegate. | ||||||||||
| virtual List::View | getDelegate () const | |||||||||
| Return a view to the delegate. | ||||||||||
| AbstractWrapperList | ( | List::Holder | ohListDelegate | ) | [protected] |
Create an AbstractWrapperList which delegates to the specified List.
| ohListDelegate | the List to delegate to |
| virtual List::Handle getDelegate | ( | ) | [protected, virtual] |
Return a handle to the delegate.
| UnsupportedOperationException | if the delegate is a view |
| virtual List::View getDelegate | ( | ) | const [protected, virtual] |
Return a view to the delegate.