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