<html> <head> <title>Interface XStringKeyMap</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="XStringKeyMap-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 XStringKeyMap</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>maps strings to anys. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.3.0</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="#getValue">getValue</a></td> <td class="imsum_right">reads data from the map. </td> </tr> <tr> <td class="imsum_left"><a href="#hasValue">hasValue</a></td> <td class="imsum_right">checks for element existence. </td> </tr> <tr> <td class="imsum_left"><a href="#insertValue">insertValue</a></td> <td class="imsum_right">writes data to the map. </td> </tr> <tr> <td class="imsum_left"><a href="#getKeyByIndex">getKeyByIndex</a></td> <td class="imsum_right">obtains the key of an element by index. </td> </tr> <tr> <td class="imsum_left"><a href="#getValueByIndex">getValueByIndex</a></td> <td class="imsum_right">obtains the value of an element by index. </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="#Count">Count</a></td> <td class="imsum_right">the number of elements 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="getValue" class="membertitle">getValue</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>getValue</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aKey )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>reads data from the map. </dd> <dt><b>Parameter aKey</b></dt> <dd>The key string which should be searched for. </dd> <dt><b>Returns</b></dt> <dd>the value matching aKey. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::container::NoSuchElementException if an element under aKey does not exist. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasValue" class="membertitle">hasValue</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>hasValue</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aKey );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>checks for element existence. </dd> <dt><b>Parameter aKey</b></dt> <dd>The key string which should be searched for. </dd> <dt><b>Returns</b></dt> <dd>true if an element with key aKey exists. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="insertValue" class="membertitle">insertValue</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>insertValue</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aKey,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> aValue )</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/IllegalArgumentException.html">IllegalArgumentException</a>,<br> <a href="ElementExistException.html">ElementExistException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>writes data to the map. </dd> <dt><b>Parameter aKey</b></dt> <dd>The key string which should be used to store the value. </dd> <dt><b>Parameter aValue</b></dt> <dd>The value that should be stored. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the element could not be inserted. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::container::ElementExistException if there is already a value stored under the key aKey. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getKeyByIndex" class="membertitle">getKeyByIndex</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">string</td> </tr> <tr> <td valign="top"><b>getKeyByIndex</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nIndex )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>obtains the key of an element by index. </dd> <dt><b>Parameter nIndex</b></dt> <dd>is the index of the element. </dd> <dt><b>Returns</b></dt> <dd>the key string matching the given index. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IndexOutOfBoundsException if the specified index is greater than the number of elements </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getValueByIndex" class="membertitle">getValueByIndex</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>getValueByIndex</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nIndex )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>obtains the value of an element by index. </dd> <dt><b>Parameter nIndex</b></dt> <dd>is the index of the key. </dd> <dt><b>Returns</b></dt> <dd>the value matching the given index. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IndexOutOfBoundsException if the specified index is greater than the number of elements </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="Count" class="membertitle">Count</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>Count</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>the number of elements in the map. </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>