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
|
/* -*- 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 .
*/
#pragma once
#include <com/sun/star/beans/IllegalTypeException.idl>
#include <com/sun/star/beans/Pair.idl>
#include <com/sun/star/container/XEnumerableMap.idl>
module com { module sun { module star { module container {
/** provides a default XEnumerableMap implementation
<p>For the keys put into the map using XMap::put() or createImmutable(),
the following rules apply:
<a name="keyrules"></a>
<ul><li>A `VOID` key is not allowed.</li>
<li>If the key type is <code>BOOLEAN</code>, <code>CHAR</code>, <code>FLOAT</code>, <code>DOUBLE</code>,
<code>STRING</code>, <code>TYPE</code>, or <code>UNSIGNED HYPER</code>, then only keys of exactly this
type are accepted.</li>
<li>If the key type is <code>DOUBLE</code> or <code>FLOAT</code>, then <code>Double.NaN</code> respectively
<code>Float.NaN</code> is not accepted as key.</li>
<li>If the key type's class is com::sun::star::uno::TypeClass::ENUM, then only keys
of exactly this type are accepted.</li>
<li>If the key type is any of <code>BYTE</code>, <code>SHORT</code>, <code>UNSIGNED SHORT</code>,
<code>LONG</code>, <code>UNSIGNED LONG</code>, or <code>HYPER</code>, then all keys which can losslessly
be converted to this type (possibly using widening conversions) are accepted.</li>
<li>If the key type is an interface type, then all key values denoting objects which can be queried for
the given interface are accepted.</li>
<li>All other key types are rejected.</li>
</ul></p>
<p>For the values put into the map using XMap::put() or createImmutable(),
the following rules apply:
<a name="valuerules"></a>
<ul><li>The `VOID` value will be accepted to be put into the map.</p>
<li>If the value type's class is com::sun::star::uno::TypeClass::ANY, any value
will be accepted.</li>
<li>If the value type is an interface type, then all values denoting objects which can be queried for
the given interface are accepted.</li>
<li>If the value type's class is com::sun::star::uno::TypeClass::EXCEPTION
or com::sun::star::uno::TypeClass::STRUCT, then values whose type equals the
value type, or is a sub class of the value type, are accepted.</li>
<li>For all other value types, only values whose type matches exactly are accepted.</li>
<li>If the value type is <code>DOUBLE</code> or <code>FLOAT</code>, then <code>Double.NaN</code> respectively
<code>Float.NaN</code> is not accepted.</li>
</ul></p>
<p>The factory methods of the <code>XEnumerableMap</code> interface support both <em>isolated</em>
and <em>non-isolated</em> 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.</p>
@see http://udk.openoffice.org/common/man/typesystem.html
*/
service EnumerableMap : XEnumerableMap
{
/** creates an instance mapping from the given key type to the given value type
@param KeyType
denotes the type of the keys in the to-be-created map
@param ValueType
denotes the type of the values in the to-be-created map
@throws ::com::sun::star::beans::IllegalTypeException
if 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.
*/
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
<p>The resulting map is immutable, so later alter operations on it will fail
with a com::sun::star::lang::NoSupportException.</p>
@param KeyType
denotes the type of the keys in the to-be-created map
@param ValueType
denotes the type of the values in the to-be-created map
@param Values
denote the values contained in the to-be-created map
@throws ::com::sun::star::beans::IllegalTypeException
if KeyType or ValueType are unsupported types.
For values, all type classes except com::sun::star::uno::TypeClass::VOID
are accepted.<br/>
For keys, scalar types, strings, com::sun::star::uno::Type itself, and interface
types are accepted.
@throws ::com::sun::star::lang::IllegalArgumentException
if any of the given values or keys violates the <a href="#keyrules">key rules</a> or
<a href="#valuerules">value rules</a>.
*/
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 );
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
