Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: 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' Summary
createKeyEnumeration | creates a enumerator for the keys of the map
createValueEnumeration | creates a enumerator for the values of the map
createElementEnumeration | creates a enumerator for the key-value pairs of the map

Methods' Details
createKeyEnumeration
XEnumeration
createKeyEnumeration( | [in] boolean | Isolated )
raises( | ::com::sun::star::lang::NoSupportException );
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
XEnumeration
createValueEnumeration( | [in] boolean | Isolated )
raises( | ::com::sun::star::lang::NoSupportException );
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
XEnumeration
createElementEnumeration( | [in] boolean | Isolated )
raises( | ::com::sun::star::lang::NoSupportException );
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 © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.