LibreOffice
LibreOffice 24.2 SDK API Reference
Loading...
Searching...
No Matches
Public Member Functions | List of all members
EnumerableMap Service Reference

provides a default XEnumerableMap implementation More...

Inheritance diagram for EnumerableMap:
XEnumerableMap XMap XElementAccess XInterface

Public Member Functions

 create ([in] type KeyType, [in] type ValueType) raises ( ::com::sun::star::beans::IllegalTypeException )
 creates an instance mapping from the given key type to the given value type
 
 createImmutable ([in] type KeyType, [in] type ValueType, [in] sequence< ::com::sun::star::beans::Pair< any, any > > Values) raises ( ::com::sun::star::beans::IllegalTypeException, ::com::sun::star::lang::IllegalArgumentException )
 creates an instance mapping from the given key type to the given value type
 
- Public Member Functions inherited from XEnumerableMap
XEnumeration createKeyEnumeration ([in] boolean Isolated) raises ( ::com::sun::star::lang::NoSupportException )
 creates an enumerator for the keys of the map
 
XEnumeration createValueEnumeration ([in] boolean Isolated) raises ( ::com::sun::star::lang::NoSupportException )
 creates an enumerator for the values of the map
 
XEnumeration createElementEnumeration ([in] boolean Isolated) raises ( ::com::sun::star::lang::NoSupportException )
 creates an enumerator for the key-value pairs of the map
 
- Public Member Functions inherited from XMap
void clear () raises ( ::com::sun::star::lang::NoSupportException )
 clears the map, removing all key-value pairs from it.
 
boolean containsKey ([in] any Key) raises ( ::com::sun::star::beans::IllegalTypeException, ::com::sun::star::lang::IllegalArgumentException )
 determines whether a mapping for he given key exists in the map
 
boolean containsValue ([in] any Value) raises ( ::com::sun::star::beans::IllegalTypeException, ::com::sun::star::lang::IllegalArgumentException )
 determines whether the map contains a mapping to a given value.
 
any get ([in] any Key) raises ( ::com::sun::star::beans::IllegalTypeException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException )
 gets the value to which a given key maps.
 
any put ([in] any Key, [in] any Value) raises ( ::com::sun::star::lang::NoSupportException, ::com::sun::star::beans::IllegalTypeException, ::com::sun::star::lang::IllegalArgumentException )
 associates a given key with a given value
 
any remove ([in] any Key) raises ( ::com::sun::star::lang::NoSupportException, ::com::sun::star::beans::IllegalTypeException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException )
 removes a key-value mapping, given by key, from the map.
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object.
 
void acquire ()
 increases the reference counter by one.
 
void release ()
 decreases the reference counter by one.
 

Additional Inherited Members

- Exported Interfaces inherited from XMap
interface XElementAccess
 
- Public Attributes inherited from XMap
type KeyType
 denotes the type of the keys in the map.
 
type ValueType
 denotes the type of the values in the map.
 

Detailed Description

provides a default XEnumerableMap implementation

For the keys put into the map using XMap::put() or createImmutable(), the following rules apply:

For the values put into the map using XMap::put() or createImmutable(), the following rules apply:

The factory methods of the XEnumerableMap interface support both isolated and non-isolated enumerators. The latter one will be automatically disposed when the map changes after enumerator creation, so every attempt to use them will result in a com::sun::star::lang::DisposedException being thrown.

See also
http://udk.openoffice.org/common/man/typesystem.html

Member Function Documentation

◆ create()

create ( [in] type  KeyType,
[in] type  ValueType 
)
raises (::com::sun::star::beans::IllegalTypeException
)

creates an instance mapping from the given key type to the given value type

Parameters
KeyTypedenotes the type of the keys in the to-be-created map
ValueTypedenotes the type of the values in the to-be-created map
Exceptions
com::sun::star::beans::IllegalTypeExceptionif KeyType or ValueType are unsupported types. For values, all type classes except com::sun::star::uno::TypeClass::VOID and com::sun::star::uno::TypeClass::UNKNOWN are accepted. For keys, scalar types, strings, com::sun::star::uno::Type itself, and interface types are accepted.

◆ createImmutable()

createImmutable ( [in] type  KeyType,
[in] type  ValueType,
[in] sequence< ::com::sun::star::beans::Pair< any, any > >  Values 
)
raises ( ::com::sun::star::beans::IllegalTypeException,
::com::sun::star::lang::IllegalArgumentException
)

creates an instance mapping from the given key type to the given value type

The resulting map is immutable, so later alter operations on it will fail with a com::sun::star::lang::NoSupportException.

Parameters
KeyTypedenotes the type of the keys in the to-be-created map
ValueTypedenotes the type of the values in the to-be-created map
Valuesdenote the values contained in the to-be-created map
Exceptions
com::sun::star::beans::IllegalTypeExceptionif KeyType or ValueType are unsupported types. For values, all type classes except com::sun::star::uno::TypeClass::VOID are accepted.
For keys, scalar types, strings, com::sun::star::uno::Type itself, and interface types are accepted.
com::sun::star::lang::IllegalArgumentExceptionif any of the given values or keys violates the key rules or value rules.

The documentation for this service was generated from the following file: