<html> <head> <title>Interface XMap</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XMap-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">container</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XMap</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XMap</strong> ┗ <a href="XElementAccess.html">XElementAccess</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XElementAccess.html">XElementAccess</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>This is the base interface of all collection interfaces. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>describes a map between keys and values. </dd> <dd><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> </dd> <dt><b>See also</b></dt> <dd><a href="XMap.html#Map">Map</a><br> for a default implementation of this interface </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#clear">clear</a></td> <td class="imsum_right">clears the map, removing all key-value pairs from it. </td> </tr> <tr> <td class="imsum_left"><a href="#containsKey">containsKey</a></td> <td class="imsum_right">determines whether a mapping for he given key exists in the map </td> </tr> <tr> <td class="imsum_left"><a href="#containsValue">containsValue</a></td> <td class="imsum_right">determines whether the map contains a mapping to a given value. </td> </tr> <tr> <td class="imsum_left"><a href="#get">get</a></td> <td class="imsum_right">gets the value to which a given key maps. </td> </tr> <tr> <td class="imsum_left"><a href="#put">put</a></td> <td class="imsum_right">associates a given key with a given value </td> </tr> <tr> <td class="imsum_left"><a href="#remove">remove</a></td> <td class="imsum_right">removes a key-value mapping, given by key, from the map. </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#KeyType">KeyType</a></td> <td class="imsum_right">denotes the type of the keys in the map. </td> </tr> <tr> <td class="imsum_left"><a href="#ValueType">ValueType</a></td> <td class="imsum_right">denotes the type of the values in the map. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="clear" class="membertitle">clear</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>clear</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>clears the map, removing all key-value pairs from it. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::beans::NoSupportException if the map is not mutable. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="containsKey" class="membertitle">containsKey</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>containsKey</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> Key )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/IllegalTypeException.html">IllegalTypeException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines whether a mapping for he given key exists in the map </dd> <dt><b>Parameter Key</b></dt> <dd>is the key whose presence in the map is to be tested. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if and only if the map contains a mapping for the given key. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::beans::IllegalTypeException if the given key is not of a type which is accepted by the map </dd> <dt><b>Throws</b></dt> <dd>::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 <b>void</b> keys, or to reject <code>Double.NaN</code> (<em>not a number</em>) to due its problematic behavior with respect to equality. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="containsValue" class="membertitle">containsValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>containsValue</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> Value )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/IllegalTypeException.html">IllegalTypeException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the map contains a mapping to a given value. </dd> <dt><b>Parameter Value</b></dt> <dd>is the value whose presence in the map is to be tested. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if and only one or more keys map to the given value. </dd> <dt><b>Throws</b></dt> <dd>::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. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException if the given value is not supported to be put into the map. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="get" class="membertitle">get</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">any</td> </tr> <tr> <td valign="top"><b>get</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> Key )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/IllegalTypeException.html">IllegalTypeException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> <a href="NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the value to which a given key maps. </dd> <dt><b>Parameter Key</b></dt> <dd>they key whose associated value is to be returned. </dd> <dt><b>Returns</b></dt> <dd>the value which is associated with the given key. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::beans::IllegalTypeException if the given key is not of a type which is accepted by the map </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::beans::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 <b>void</b> keys, or to reject <code>Double.NaN</code> (<em>not a number</em>) to due its problematic behavior with respect to equality. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::NoSuchElementException if there is no value associated with the given key </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="put" class="membertitle">put</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">any</td> </tr> <tr> <td valign="top"><b>put</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> Key,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> Value )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a>,<br> ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/IllegalTypeException.html">IllegalTypeException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>associates a given key with a given value </dd> <dd><p>If the map already contains a mapping for the given key, then the old value is replaced by the given new value.</p> </dd> <dt><b>Parameter Key</b></dt> <dd>is the key which the given value should be associated with </dd> <dt><b>Parameter Value</b></dt> <dd>is the value which should be associated with the given key </dd> <dt><b>Returns</b></dt> <dd>the value which was previously associated with the given key, or <b>void</b> if there was no such previous association. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::beans::IllegalTypeException if the given key is not of a type which is accepted by the map </dd> <dt><b>Throws</b></dt> <dd>::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 <b>void</b> keys or values, or to reject <code>Double.NaN</code> (<em>not a number</em>) to due its problematic behavior with respect to equality. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::beans::NoSupportException if the map does not support putting new mappings into it </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="remove" class="membertitle">remove</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">any</td> </tr> <tr> <td valign="top"><b>remove</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> Key )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a>,<br> ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/IllegalTypeException.html">IllegalTypeException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> <a href="NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes a key-value mapping, given by key, from the map. </dd> <dt><b>Parameter Key</b></dt> <dd>is the key whose mapping should be removed from the map </dd> <dt><b>Returns</b></dt> <dd>the value which was associated with the given key before the removal </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::beans::IllegalTypeException if the given key is not of a type which is accepted by the map </dd> <dt><b>Throws</b></dt> <dd>::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 <b>void</b> keys, or to reject <code>Double.NaN</code> (<em>not a number</em>) to due its problematic behavior with respect to equality. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::beans::NoSupportException if the map does not support removing mappings </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::NoSuchElementException if there is no value associated with the given key </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="KeyType" class="membertitle">KeyType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] type <b>KeyType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes the type of the keys in the map. </dd> <dd><p>Implementations are free to accept any supertype of <code>KeyType</code> as keys.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ValueType" class="membertitle">ValueType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] type <b>ValueType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes the type of the values in the map. </dd> <dd><p>Implementations are free to accept any supertype of the <code>ValueType</code> as values.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
2170
