:: com :: sun :: star :: container ::
|
unpublished |
interface XEnumerableMap |
|
|
- Base Interfaces
XEnumerableMap
┗ XMap
┗ XElementAccess
XMap |
- (referenced interface's summary:)
- describes a map between keys and values.
|
|
- Usage Restrictions
- not published
- Description
- extends XMap with enumeration capabilities.
No assumption should be made about the ordering of the elements returned by the various enumerators.
In particular, you cannot assume the elements are returned in the same order as they were inserted. Also,
you should not expect the XMap implementation to make use of a possibly existing strict ordering
defined on the domain of all possible key values.
You can create enumerators for the keys of the map, its values, and its key-value pairs.
In all cases, you can create an isolated enumerator, which works on a copy of the
map's content. Such an iterator is not affected by changes done to the map after creation of
the enumerator.
On the contrary, an enumerator which is non-isolated works directly on the map data.
This is less expensive than an isolated enumerator, but means that changes to the map while
an enumeration is running potentially invalidate your enumerator. The concrete behavior in this
case is undefined, it's up to the service implementing the XEnumerableMap interface
to specify it in more detail.
Implementations of this interface might decide to support only isolated enumerators, or
only non-isolated enumerators. Again, it's up to the service to specify this. Requesting an
enumerator type which is not supported will generally result in an ::com::sun::star::lang::NoSupportException
being thrown.
|
Methods' Details |
createKeyEnumeration
- Description
- creates a enumerator for the keys of the map
- Parameter Isolated
- controls whether the newly create enumerator should be isolated from the map.
- Throws
- ::com::sun::star::lang::NoSupportException
if the specified enumerator method is not supported by the implementation.
|
|
createValueEnumeration
- Description
- creates a enumerator for the values of the map
- Parameter Isolated
- controls whether the newly create enumerator should be isolated from the map.
- Throws
- ::com::sun::star::lang::NoSupportException
if the specified enumerator method is not supported by the implementation.
|
|
createElementEnumeration
- Description
- creates a enumerator for the key-value pairs of the map
The elements returned by the enumerator are instances of com::sun::star::beans::Pair,
holding the key-value-pairs which are part of the map.
- Parameter Isolated
- controls whether the newly create enumerator should be isolated from the map.
- Throws
- ::com::sun::star::lang::NoSupportException
if the specified enumerator method is not supported by the implementation.
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.