#include <coherence/util/WrapperCollections.hpp>
Inherits Object, and Map::Entry.
Inherited by ConverterCollections::ConverterEntry, and TypedCollections::TypedEntry.
Public Types | ||||
typedef spec::Handle | Handle | |||
AbstractWrapperEntry Handle definition. | ||||
typedef spec::View | View | |||
AbstractWrapperEntry View definition. | ||||
typedef spec::Holder | Holder | |||
AbstractWrapperEntry Holder definition. | ||||
Public Member Functions | ||||
virtual Object::View | getKey () const | |||
Return the key corresponding to this entry.
| ||||
virtual Object::Holder | getValue () const | |||
Return the value corresponding to this entry.
| ||||
virtual Object::Holder | getValue () | |||
Return the value corresponding to this entry.
| ||||
virtual Object::Holder | setValue (Object::Holder ohValue) | |||
Update the value corresponding to this entry.
| ||||
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 managed 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);
| ||||
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 | ||||
AbstractWrapperEntry (Map::Entry::Holder ohEntryDelegate) | ||||
Create an AbstractWrapperEntry which delegates to the specified Map::Entry. | ||||
AbstractWrapperEntry (const AbstractWrapperEntry &that) | ||||
Copy constructor. | ||||
virtual Map::Entry::Handle | getDelegate () | |||
Return a handle to the delegate. | ||||
virtual Map::Entry::View | getDelegate () const | |||
Return a view to the delegate. |
AbstractWrapperEntry | ( | Map::Entry::Holder | ohEntryDelegate | ) | [protected] |
Create an AbstractWrapperEntry which delegates to the specified Map::Entry.
ohEntryDelegate | the Entry to delegate to |
virtual Map::Entry::Handle getDelegate | ( | ) | [protected, virtual] |
Return a handle to the delegate.
UnsupportedOperationException | if the delegate is a view |
virtual Map::Entry::View getDelegate | ( | ) | const [protected, virtual] |
Return a view to the delegate.