Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 193 insertions, 0 deletions

diff --git a/udkapi/com/sun/star/container/XMap.idl b/udkapi/com/sun/star/container/XMap.idl
new file mode 100644
index 000000000..b4f25fb82
--- /dev/null
+++ b/udkapi/com/sun/star/container/XMap.idl
@@ -0,0 +1,193 @@
+/* -*- 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 .
+ */
+
+#ifndef __com_sun_star_container_XMap_idl__
+#define __com_sun_star_container_XMap_idl__
+
+#include <com/sun/star/beans/IllegalTypeException.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#include <com/sun/star/container/NoSuchElementException.idl>
+#include <com/sun/star/lang/NoSupportException.idl>
+#include <com/sun/star/container/XElementAccess.idl>
+
+
+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 );
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */