udkapi/com/sun/star/container/XStringKeyMap.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module container {
  22
  23
  24 /** maps strings to anys.
  25
  26     @since OOo 2.3
  27  */
  28
  29 interface XStringKeyMap
  30 {
  31     /** reads data from the map.
  32
  33         @param aKey
  34                 The key string which should be searched for.
  35
  36         @return
  37                 the value matching aKey.
  38
  39         @throws com::sun::star::container::NoSuchElementException
  40                 if an element under aKey does not exist.
  41      */
  42     any getValue( [in] string aKey )
  43         raises( com::sun::star::container::NoSuchElementException );
  44
  45
  46     /** checks for element existence.
  47
  48         @param aKey
  49                 The key string which should be searched for.
  50
  51         @return
  52                 true if an element with key aKey exists.
  53      */
  54     boolean hasValue( [in] string aKey );
  55
  56
  57     /** writes data to the map.
  58
  59         @param aKey
  60                 The key string which should be used to store the value.
  61
  62         @param aValue
  63                 The value that should be stored.
  64
  65         @throws com::sun::star::lang::IllegalArgumentException
  66                 if the element could not be inserted.
  67
  68         @throws com::sun::star::container::ElementExistException
  69                 if there is already a value stored under the key aKey.
  70      */
  71     void insertValue( [in] string aKey, [in] any aValue )
  72         raises( com::sun::star::lang::IllegalArgumentException,
  73                 com::sun::star::container::ElementExistException );
  74
  75
  76     /** the number of elements in the map.
  77      */
  78     [attribute, readonly] long Count;
  79
  80
  81     /** obtains the key of an element by index.
  82
  83         @param nIndex
  84                 is the index of the element.
  85
  86         @return
  87                 the key string matching the given index.
  88
  89         @throws com::sun::star::lang::IndexOutOfBoundsException
  90                 if the specified index is greater than the number of
  91                 elements
  92      */
  93     string getKeyByIndex( [in] long nIndex )
  94         raises( com::sun::star::lang::IndexOutOfBoundsException );
  95
  96
  97     /** obtains the value of an element by index.
  98
  99         @param nIndex
 100                 is the index of the key.
 101
 102         @return
 103                 the value matching the given index.
 104
 105         @throws com::sun::star::lang::IndexOutOfBoundsException
 106                 if the specified index is greater than the number of
 107                 elements
 108      */
 109     any getValueByIndex( [in] long nIndex )
 110         raises( com::sun::star::lang::IndexOutOfBoundsException );
 111 };
 112
 113 }; }; }; };
 114
 115 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */