Package org.jfree.report.util
Class ReportParameters
java.lang.Object
org.jfree.report.util.ReportParameters
- All Implemented Interfaces:
Serializable
,Cloneable
The report parameters collection is a map with string keys. The parameters
can be used in a query and will appear as part of the datarow.
- Author:
- Thomas Morgner
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.ReportParameters
(ReportParameters props) Copy constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Removes all properties stored in this collection.clone()
Clones the properties.boolean
containsKey
(String key) Checks whether the given key is stored in this collection of ReportProperties.Retrieves the value stored for a key in this properties collection.Retrieves the value stored for a key in this properties collection, and returning the default value if the key was not stored in this properties collection.String[]
keys()
Returns all property keys as array.void
Adds a property to this properties collection.int
size()
-
Constructor Details
-
ReportParameters
Copy constructor.- Parameters:
props
- an existing ReportProperties instance.
-
ReportParameters
public ReportParameters()Default constructor.
-
-
Method Details
-
put
Adds a property to this properties collection. If a property with the given name exist, the property will be replaced with the new value. If the value is null, the property will be removed.- Parameters:
key
- the property key.value
- the property value.
-
get
Retrieves the value stored for a key in this properties collection.- Parameters:
key
- the property key.- Returns:
- The stored value, or
null
if the key does not exist in this collection.
-
get
Retrieves the value stored for a key in this properties collection, and returning the default value if the key was not stored in this properties collection.- Parameters:
key
- the property key.defaultValue
- the default value to be returned when the key is not stored in this properties collection.- Returns:
- The stored value, or the default value if the key does not exist in this collection.
-
keys
Returns all property keys as array.- Returns:
- an enumeration of the property keys.
-
clear
public void clear()Removes all properties stored in this collection. -
containsKey
Checks whether the given key is stored in this collection of ReportProperties.- Parameters:
key
- the property key.- Returns:
- true, if the given key is known.
-
clone
Clones the properties.- Overrides:
clone
in classObject
- Returns:
- a copy of this ReportProperties object.
- Throws:
CloneNotSupportedException
- this should never happen.
-
size
public int size()
-