org.jfree.report.util

Class ReportParameters

public final class ReportParameters extends Object implements 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

Constructor Summary
ReportParameters(ReportParameters props)
Copy constructor.
ReportParameters()
Default constructor.
Method Summary
voidclear()
Removes all properties stored in this collection.
Objectclone()
Clones the properties.
booleancontainsKey(String key)
Checks whether the given key is stored in this collection of ReportProperties.
Objectget(String key)
Retrieves the value stored for a key in this properties collection.
Objectget(String key, Object defaultValue)
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.
voidput(String key, Object value)
Adds a property to this properties collection.
intsize()

Constructor Detail

ReportParameters

public ReportParameters(ReportParameters props)
Copy constructor.

Parameters: props an existing ReportProperties instance.

ReportParameters

public ReportParameters()
Default constructor.

Method Detail

clear

public void clear()
Removes all properties stored in this collection.

clone

public Object clone()
Clones the properties.

Returns: a copy of this ReportProperties object.

Throws: CloneNotSupportedException this should never happen.

containsKey

public boolean containsKey(String key)
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.

get

public Object get(String key)
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

public Object get(String key, Object defaultValue)
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

public String[] keys()
Returns all property keys as array.

Returns: an enumeration of the property keys.

put

public void put(String key, Object value)
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.

size

public int size()