1 /************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 package com.sun.star.report; 24 25 public interface ParameterMap 26 { 27 28 /** 29 * Adds a property to this properties collection. If a property with the given name 30 * exist, the property will be replaced with the new value. If the value is null, the 31 * property will be removed. 32 * 33 * @param key the property key. 34 * @param value the property value. 35 */ put(final String key, final Object value)36 public void put(final String key, final Object value); 37 38 /** 39 * Retrieves the value stored for a key in this properties collection. 40 * 41 * @param key the property key. 42 * @return The stored value, or <code>null</code> if the key does not exist in this 43 * collection. 44 */ get(final String key)45 Object get(final String key); 46 47 /** 48 * Retrieves the value stored for a key in this properties collection, and returning the 49 * default value if the key was not stored in this properties collection. 50 * 51 * @param key the property key. 52 * @param defaultValue the default value to be returned when the key is not stored in 53 * this properties collection. 54 * @return The stored value, or the default value if the key does not exist in this 55 * collection. 56 */ get(final String key, final Object defaultValue)57 Object get(final String key, final Object defaultValue); 58 keys()59 String[] keys(); 60 clear()61 void clear(); 62 size()63 int size(); 64 } 65