Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: container ::
unpublished | interface XStringKeyMap |
Usage Restrictions not published Description maps strings to anys. Since OOo 2.3

Methods' Summary
getValue | reads data from the map.
hasValue | checks for element existence.
insertValue | writes data to the map.
getKeyByIndex | obtains the key of an element by index.
getValueByIndex | obtains the value of an element by index.

Attributes' Summary
Count | the number of elements in the map.

Methods' Details
getValue
any
getValue( | [in] string | aKey )
raises( | NoSuchElementException );
Description reads data from the map. Parameter aKey The key string which should be searched for. Returns the value matching aKey. Throws com::sun::star::container::NoSuchElementException if an element under aKey does not exist.
hasValue
boolean
hasValue( | [in] string | aKey );
Description checks for element existence. Parameter aKey The key string which should be searched for. Returns true if an element with key aKey exists.
insertValue
void
insertValue( | [in] string | aKey,
| [in] any | aValue )
raises( | ::com::sun::star::lang::IllegalArgumentException, ElementExistException );
Description writes data to the map. Parameter aKey The key string which should be used to store the value. Parameter aValue The value that should be stored. Throws com::sun::star::lang::IllegalArgumentException if the element could not be inserted. Throws com::sun::star::container::ElementExistException if there is already a value stored under the key aKey.
getKeyByIndex
string
getKeyByIndex( | [in] long | nIndex )
raises( | ::com::sun::star::lang::IndexOutOfBoundsException );
Description obtains the key of an element by index. Parameter nIndex is the index of the element. Returns the key string matching the given index. Throws com::sun::star::lang::IndexOutOfBoundsException if the specified index is greater than the number of elements
getValueByIndex
any
getValueByIndex( | [in] long | nIndex )
raises( | ::com::sun::star::lang::IndexOutOfBoundsException );
Description obtains the value of an element by index. Parameter nIndex is the index of the key. Returns the value matching the given index. Throws com::sun::star::lang::IndexOutOfBoundsException if the specified index is greater than the number of elements

Attributes' Details
Count
[ readonly ] long Count; Description the number of elements in the map.

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.