net.sf.jasperreports.engine

Class JRPropertiesMap

java.lang.Object

net.sf.jasperreports.engine.JRPropertiesMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class JRPropertiesMap
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Properties map of an JR element.

The order of the properties (obtained by getPropertyNames() is the same as the order in which the properties were added.

Version:

$Id: JRPropertiesMap.java 4595 2011-09-08 15:55:10Z teodord $

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_VALUE

Constructor Summary

Constructors

Constructor and Description
JRPropertiesMap() Creates a properties map.
JRPropertiesMap(JRPropertiesMap propertiesMap) Clones a properties map.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone()
JRPropertiesMap	cloneProperties() Clones this property map.
protected void	collectPropertyNames(java.util.Collection<java.lang.String> names)
boolean	containsProperty(java.lang.String propName) Decides whether the map contains a specified property.
protected void	ensureInit()
JRPropertiesMap	getBaseProperties() Returns the base properties map, if any.
JRPropertyChangeSupport	getEventSupport()
protected java.lang.String	getOwnProperty(java.lang.String propName)
static JRPropertiesMap	getPropertiesClone(JRPropertiesHolder propertiesHolder) Clones the properties map of a properties holder.
java.lang.String	getProperty(java.lang.String propName) Returns the value of a property.
java.lang.String[]	getPropertyNames() Returns the names of the properties.
boolean	hasOwnProperties() Checks whether this object has properties of its own (i.e.
protected boolean	hasOwnProperty(java.lang.String propName)
boolean	hasProperties() Checks whether there are any properties.
static JRPropertiesMap	loadProperties(java.net.URL location) Loads a properties file from a location.
void	removeProperty(java.lang.String propName) Removes a property.
void	setBaseProperties(JRPropertiesMap base) Sets the base properties map.
void	setProperty(java.lang.String propName, java.lang.String value) Adds/sets a property value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_VALUE

public static final java.lang.String PROPERTY_VALUE

See Also:

Constant Field Values

Constructor Detail

JRPropertiesMap

public JRPropertiesMap()

Creates a properties map.

JRPropertiesMap

public JRPropertiesMap(JRPropertiesMap propertiesMap)

Clones a properties map.

Parameters:

propertiesMap - the original properties map

Method Detail

ensureInit

protected void ensureInit()

getPropertyNames

public java.lang.String[] getPropertyNames()

Returns the names of the properties.

Returns:

the names of the properties

collectPropertyNames

protected void collectPropertyNames(java.util.Collection<java.lang.String> names)

getProperty

public java.lang.String getProperty(java.lang.String propName)

Returns the value of a property.

Parameters:

propName - the name of the property

Returns:

the value

containsProperty

public boolean containsProperty(java.lang.String propName)

Decides whether the map contains a specified property. The method returns true even if the property value is null.

Parameters:

propName - the property name

Returns:

true if and only if the map contains the property

hasOwnProperty

protected boolean hasOwnProperty(java.lang.String propName)

getOwnProperty

protected java.lang.String getOwnProperty(java.lang.String propName)

setProperty

public void setProperty(java.lang.String propName,
               java.lang.String value)

Adds/sets a property value.

Parameters:

propName - the name of the property

value - the value of the property

removeProperty

public void removeProperty(java.lang.String propName)

Removes a property.

Parameters:

propName - the property name

cloneProperties

public JRPropertiesMap cloneProperties()

Clones this property map.

Returns:

a clone of this property map

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hasProperties

public boolean hasProperties()

Checks whether there are any properties.

Returns:

whether there are any properties

hasOwnProperties

public boolean hasOwnProperties()

Checks whether this object has properties of its own (i.e. not inherited from the base properties).

Returns:

whether this object has properties of its own

See Also:

setBaseProperties(JRPropertiesMap)

getPropertiesClone

public static JRPropertiesMap getPropertiesClone(JRPropertiesHolder propertiesHolder)

Clones the properties map of a properties holder. If the holder does not have any properties, null is returned.

Parameters:

propertiesHolder - the properties holder

Returns:

a clone of the holder's properties map, or null if the holder does not have any properties

getBaseProperties

public JRPropertiesMap getBaseProperties()

Returns the base properties map, if any.

Returns:

the base properties map

See Also:

setBaseProperties(JRPropertiesMap)

setBaseProperties

public void setBaseProperties(JRPropertiesMap base)

Sets the base properties map.

The base properties map are used as base/default properties for this instance. All of the containsProperty(String), getProperty(String), getPropertyNames() and hasProperties() methods include base properties as well.

Parameters:

base - the base properties map

loadProperties

public static JRPropertiesMap loadProperties(java.net.URL location)

Loads a properties file from a location.

Parameters:

location - the properties file URL

Returns:

the properties file loaded as a in-memory properties map

getEventSupport

public JRPropertyChangeSupport getEventSupport()