1 /************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 package com.sun.star.report; 28 29 public interface ParameterMap 30 { 31 32 /** 33 * Adds a property to this properties collection. If a property with the given name 34 * exist, the property will be replaced with the new value. If the value is null, the 35 * property will be removed. 36 * 37 * @param key the property key. 38 * @param value the property value. 39 */ 40 public void put(final String key, final Object value); 41 42 /** 43 * Retrieves the value stored for a key in this properties collection. 44 * 45 * @param key the property key. 46 * @return The stored value, or <code>null</code> if the key does not exist in this 47 * collection. 48 */ 49 Object get(final String key); 50 51 /** 52 * Retrieves the value stored for a key in this properties collection, and returning the 53 * default value if the key was not stored in this properties collection. 54 * 55 * @param key the property key. 56 * @param defaultValue the default value to be returned when the key is not stored in 57 * this properties collection. 58 * @return The stored value, or the default value if the key does not exist in this 59 * collection. 60 */ 61 Object get(final String key, final Object defaultValue); 62 63 String[] keys(); 64 65 void clear(); 66 67 int size(); 68 } 69