1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
module com { module sun { module star { module container {
/** describes a map between keys and values.
<p>Keys in the map are unique, and each key maps to exactly one value.</p>
<p>Locating elements in the map, both values and keys, requires a notion of equality of two objects.
In conformance with the <a href="http://udk.openoffice.org/common/man/typesystem.html">UNO type system</a>,
two values are said to be equal if and only if they have the same type, and both denote the same element of this
type's value set.</p>
@see Map for a default implementation of this interface
*/
interface XMap
{
interface XElementAccess;
/** denotes the type of the keys in the map.
<p>Implementations are free to accept any supertype of <code>KeyType</code> as keys.</p>
*/
[attribute, readonly] type KeyType;
/** denotes the type of the values in the map.
<p>Implementations are free to accept any supertype of the <code>ValueType</code> as values.</p>
*/
[attribute, readonly] type ValueType;
/** clears the map, removing all key-value pairs from it.
@throws ::com::sun::star::lang::NoSupportException
if the map is not mutable.
*/
void clear()
raises( ::com::sun::star::lang::NoSupportException );
/** determines whether a mapping for he given key exists in the map
@param Key
is the key whose presence in the map is to be tested.
@return
`TRUE` if and only if the map contains a mapping for the given key.
@throws ::com::sun::star::beans::IllegalTypeException
if the given key is not of a type which is accepted by the map
@throws ::com::sun::star::lang::IllegalArgumentException
if the given key is not supported to be put into the map. It's up to the service
implementing the <code>XMap</code> interface to specify which special values are not
supported. For instances, implementations might decide to not allow `VOID` keys, or
to reject <code>Double.NaN</code> (<em>not a number</em>) to due its problematic
behavior with respect to equality.
*/
boolean containsKey( [in] any Key )
raises( ::com::sun::star::beans::IllegalTypeException,
::com::sun::star::lang::IllegalArgumentException );
/** determines whether the map contains a mapping to a given value.
@param Value
is the value whose presence in the map is to be tested.
@return
`TRUE` if and only one or more keys map to the given value.
@throws ::com::sun::star::beans::IllegalTypeException
if the given value is not of a type which is accepted by the map. It's up to the service
implementing the <code>XMap</code> interface to specify which special values are not
supported. For instances, implementations might decide to not allow <code>Double.NaN</code>
(<em>not a number</em>) to due its problematic behavior with respect to equality.
@throws ::com::sun::star::lang::IllegalArgumentException
if the given value is not supported to be put into the map.
*/
boolean containsValue( [in] any Value )
raises( ::com::sun::star::beans::IllegalTypeException,
::com::sun::star::lang::IllegalArgumentException );
/** gets the value to which a given key maps.
@param Key
they key whose associated value is to be returned.
@return
the value which is associated with the given key.
@throws ::com::sun::star::beans::IllegalTypeException
if the given key is not of a type which is accepted by the map
@throws ::com::sun::star::lang::IllegalArgumentException
if the given key is not supported to be put into the map. It's up to the service
implementing the <code>XMap</code> interface to specify which special values are not
supported. For instances, implementations might decide to not allow `VOID` keys, or
to reject <code>Double.NaN</code> (<em>not a number</em>) to due its problematic
behavior with respect to equality.
@throws ::com::sun::star::container::NoSuchElementException
if there is no value associated with the given key
*/
any get( [in] any Key )
raises( ::com::sun::star::beans::IllegalTypeException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::NoSuchElementException );
/** associates a given key with a given value
<p>If the map already contains a mapping for the given key, then the old value is replaced by the
given new value.</p>
@param Key
is the key which the given value should be associated with
@param Value
is the value which should be associated with the given key
@return
the value which was previously associated with the given key, or `VOID`
if there was no such previous association.
@throws ::com::sun::star::beans::IllegalTypeException
if the given key is not of a type which is accepted by the map
@throws ::com::sun::star::lang::IllegalArgumentException
if the given key, or the given value, is not supported to be put into the map. It's up to
the service implementing the <code>XMap</code> interface to specify which special values
are not supported.<br/>
For instances, implementations might decide to not allow `VOID` keys or values, or to
reject <code>Double.NaN</code> (<em>not a number</em>) to due its problematic behavior
with respect to equality.
@throws ::com::sun::star::lang::NoSupportException
if the map does not support putting new mappings into it
*/
any put( [in] any Key, [in] any Value )
raises( ::com::sun::star::lang::NoSupportException,
::com::sun::star::beans::IllegalTypeException,
::com::sun::star::lang::IllegalArgumentException );
/** removes a key-value mapping, given by key, from the map.
@param Key
is the key whose mapping should be removed from the map
@return
the value which was associated with the given key before the removal
@throws ::com::sun::star::beans::IllegalTypeException
if the given key is not of a type which is accepted by the map
@throws ::com::sun::star::lang::IllegalArgumentException
if the given key is not supported to be put into the map. It's up to the service
implementing the <code>XMap</code> interface to specify which special values are not
supported. For instances, implementations might decide to not allow `VOID` keys, or
to reject <code>Double.NaN</code> (<em>not a number</em>) to due its problematic
behavior with respect to equality.
@throws ::com::sun::star::lang::NoSupportException
if the map does not support removing mappings
@throws ::com::sun::star::container::NoSuchElementException
if there is no value associated with the given key
*/
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 );
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
