1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XStringKeyMap_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_container_XStringKeyMap_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_ElementExistException_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/container/ElementExistException.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 40*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 41*b1cdbd2cSJim Jagielski#endif 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_NoSuchElementException_idl__ 44*b1cdbd2cSJim Jagielski#include <com/sun/star/container/NoSuchElementException.idl> 45*b1cdbd2cSJim Jagielski#endif 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski//============================================================================= 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module container { 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski//============================================================================= 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski/** maps strings to anys. 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski @since OpenOffice 2.3 56*b1cdbd2cSJim Jagielski */ 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielskiinterface XStringKeyMap 59*b1cdbd2cSJim Jagielski{ 60*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 61*b1cdbd2cSJim Jagielski /** reads data from the map. 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski @param aKey 64*b1cdbd2cSJim Jagielski The key string which should be searched for. 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski @return 67*b1cdbd2cSJim Jagielski the value matching aKey. 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski @throws com::sun::star::container::NoSuchElementException 70*b1cdbd2cSJim Jagielski if an element under aKey does not exist. 71*b1cdbd2cSJim Jagielski */ 72*b1cdbd2cSJim Jagielski any getValue( [in] string aKey ) 73*b1cdbd2cSJim Jagielski raises( com::sun::star::container::NoSuchElementException ); 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 77*b1cdbd2cSJim Jagielski /** checks for element existence. 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski @param aKey 80*b1cdbd2cSJim Jagielski The key string which should be searched for. 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski @return 83*b1cdbd2cSJim Jagielski true if an element with key aKey exists. 84*b1cdbd2cSJim Jagielski */ 85*b1cdbd2cSJim Jagielski boolean hasValue( [in] string aKey ); 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 89*b1cdbd2cSJim Jagielski /** writes data to the map. 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski @param aKey 92*b1cdbd2cSJim Jagielski The key string which should be used to store the value. 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski @param aValue 95*b1cdbd2cSJim Jagielski The value that should be stored. 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::IllegalArgumentException 98*b1cdbd2cSJim Jagielski if the element could not be inserted. 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski @throws com::sun::star::container::ElementExistException 101*b1cdbd2cSJim Jagielski if there is already a value stored under the key aKey. 102*b1cdbd2cSJim Jagielski */ 103*b1cdbd2cSJim Jagielski void insertValue( [in] string aKey, [in] any aValue ) 104*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::IllegalArgumentException, 105*b1cdbd2cSJim Jagielski com::sun::star::container::ElementExistException ); 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 109*b1cdbd2cSJim Jagielski /** the number of elements in the map. 110*b1cdbd2cSJim Jagielski */ 111*b1cdbd2cSJim Jagielski [attribute, readonly] long Count; 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 115*b1cdbd2cSJim Jagielski /** obtains the key of an element by index. 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski @param nIndex 118*b1cdbd2cSJim Jagielski is the index of the element. 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski @return 121*b1cdbd2cSJim Jagielski the key string matching the given index. 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::IndexOutOfBoundsException 124*b1cdbd2cSJim Jagielski if the specified index is greater than the number of 125*b1cdbd2cSJim Jagielski elements 126*b1cdbd2cSJim Jagielski */ 127*b1cdbd2cSJim Jagielski string getKeyByIndex( [in] long nIndex ) 128*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::IndexOutOfBoundsException ); 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski 131*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 132*b1cdbd2cSJim Jagielski /** obtains the value of an element by index. 133*b1cdbd2cSJim Jagielski 134*b1cdbd2cSJim Jagielski @param nIndex 135*b1cdbd2cSJim Jagielski is the index of the key. 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski @return 138*b1cdbd2cSJim Jagielski the value matching the given index. 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::IndexOutOfBoundsException 141*b1cdbd2cSJim Jagielski if the specified index is greater than the number of 142*b1cdbd2cSJim Jagielski elements 143*b1cdbd2cSJim Jagielski */ 144*b1cdbd2cSJim Jagielski any getValueByIndex( [in] long nIndex ) 145*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::IndexOutOfBoundsException ); 146*b1cdbd2cSJim Jagielski}; 147*b1cdbd2cSJim Jagielski 148*b1cdbd2cSJim Jagielski}; }; }; }; 149*b1cdbd2cSJim Jagielski 150*b1cdbd2cSJim Jagielski#endif 151