net.sf.jasperreports.engine.util

Class JRProperties

java.lang.Object

net.sf.jasperreports.engine.util.JRProperties

Deprecated.

Replaced by JRPropertiesUtil.

public final class JRProperties
extends Object

Class that provides static methods for loading, getting and setting properties.

The following actions are performed:

• The default (hardcoded) properties are set.
• If the system property "net.sf.jasperreports.properties" has been set then the specified proprties file is loaded.
• Otherwise "jasperreports.properties" is loaded if found in the classpath.
• For backward compatibility, system properties like "jasper.reports.compile.xml.validation" are checked and their values are used. This way of specifying properties is deprecated.

Version:

$Id: JRProperties.java 5666 2012-09-14 14:08:19Z teodord $

Author:

Lucian Chirita ([email protected])

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JRProperties.PropertySuffix Deprecated. Class used by getProperties(String).

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPILER_CLASS Deprecated. Replaced by JRCompiler.COMPILER_PREFIX.
static String	COMPILER_CLASSPATH Deprecated. Replaced by JRCompiler.COMPILER_CLASSPATH.
static String	COMPILER_KEEP_JAVA_FILE Deprecated. Replaced by JRCompiler.COMPILER_KEEP_JAVA_FILE.
static String	COMPILER_TEMP_DIR Deprecated. Replaced by JRCompiler.COMPILER_TEMP_DIR.
static String	COMPILER_XML_VALIDATION Deprecated. Replaced by JRReportSaxParserFactory.COMPILER_XML_VALIDATION.
protected static String	DEFAULT_PROPERTIES_FILE Deprecated. Replaced by DefaultJasperReportsContext.DEFAULT_PROPERTIES_FILE.
static String	EXPORT_XML_VALIDATION Deprecated. Replaced by PrintSaxParserFactory.EXPORT_XML_VALIDATION.
static String	PDF_FONT_DIRS_PREFIX Deprecated. Replaced by JRPdfExporter.PDF_FONT_DIRS_PREFIX.
static String	PDF_FONT_FILES_PREFIX Deprecated. Replaced by JRPdfExporter.PDF_FONT_FILES_PREFIX.
protected static ConcurrentHashMap<String,String>	properties Deprecated.
static String	PROPERTIES_FILE Deprecated. Replaced by DefaultJasperReportsContext.PROPERTIES_FILE.
static String	PROPERTY_PREFIX Deprecated. Replaced by JRPropertiesUtil.PROPERTY_PREFIX.
static String	QUERY_EXECUTER_FACTORY_PREFIX Deprecated. Replaced by net.sf.jasperreports.engine.query.
protected static HashMap<String,String>	savedProps Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	asBoolean(String value) Deprecated. Converts a String value into a boolean.
static Character	asCharacter(String value) Deprecated. Converts a String into a Character value.
static float	asFloat(String value) Deprecated. Converts a String value into a float.
static int	asInteger(String value) Deprecated. Converts a String value into a int.
static long	asLong(String value) Deprecated. Converts a String value into a long.
static void	backupProperties() Deprecated. Saves a copy of the current properties.
static List<JRProperties.PropertySuffix>	getAllProperties(JRPropertiesHolder propertiesHolder, String prefix) Deprecated. Returns the list of all properties for a key prefix, including global properties.
static List<JRProperties.PropertySuffix>	getAllProperties(JRPropertiesMap propertiesMap, String prefix) Deprecated. Returns the list of all properties for a key prefix, including global properties.
static Boolean	getBooleanProperty(JRPropertiesHolder propertiesHolder, String key) Deprecated. Returns the value of a property as a Boolean object, looking first in the supplied properties holder and then in the system properties.
static boolean	getBooleanProperty(JRPropertiesHolder propertiesHolder, String key, boolean defaultValue) Deprecated. Returns the value of a property as a boolean, looking first in the supplied properties holder and then in the system properties.
static boolean	getBooleanProperty(JRPropertiesMap propertiesMap, String key, boolean defaultValue) Deprecated. Returns the value of a property as a boolean, looking first in the supplied properties map and then in the system properties.
static boolean	getBooleanProperty(String key) Deprecated. Returns a property as a boolean value.
static Character	getCharacterProperty(JRPropertiesMap propertiesMap, String key) Deprecated. Returns the value of a property as a Character value, looking first in the supplied properties holder and then in the system properties.
static Character	getCharacterProperty(String key) Deprecated. Returns a property as a Character value.
protected static Properties	getDefaults() Deprecated. Sets the default properties.
static float	getFloatProperty(JRPropertiesHolder propertiesHolder, String key, float defaultValue) Deprecated. Returns the value of a property as a float, looking first in the supplied properties holder and then in the system properties.
static float	getFloatProperty(JRPropertiesMap propertiesMap, String key, float defaultValue) Deprecated. Returns the value of a property as a float, looking first in the supplied properties map and then in the system properties.
static float	getFloatProperty(String key) Deprecated. Returns a property as a float value.
static float	getFloatProperty(String key, float defaultValue) Deprecated. Returns the value of a property as a float.
static int	getIntegerProperty(JRPropertiesHolder propertiesHolder, String key, int defaultValue) Deprecated. Returns the value of a property as an integer, looking first in the supplied properties holder and then in the system properties.
static int	getIntegerProperty(JRPropertiesMap propertiesMap, String key, int defaultValue) Deprecated. Returns the value of a property as an integer, looking first in the supplied properties map and then in the system properties.
static int	getIntegerProperty(String key) Deprecated. Returns a property as an integer value.
static int	getIntegerProperty(String key, int defaultValue) Deprecated. Returns the value of a property as an integer.
static long	getLongProperty(JRPropertiesHolder propertiesHolder, String key, int defaultValue) Deprecated. Returns the value of a property as a long, looking first in the supplied properties holder and then in the system properties.
static long	getLongProperty(JRPropertiesMap propertiesMap, String key, int defaultValue) Deprecated. Returns the value of a property as a long, looking first in the supplied properties map and then in the system properties.
static long	getLongProperty(String key) Deprecated. Returns a property as a long value.
protected static JRPropertiesMap	getOwnProperties(JRPropertiesHolder propertiesHolder) Deprecated.
static List<JRProperties.PropertySuffix>	getProperties(JRPropertiesHolder propertiesHolder, String prefix) Deprecated. Returns the list of all properties for a key prefix.
static List<JRProperties.PropertySuffix>	getProperties(JRPropertiesMap propertiesMap, String prefix) Deprecated. Returns the list of all properties for a key prefix.
static List<JRProperties.PropertySuffix>	getProperties(String prefix) Deprecated. Returns the list of all properties for a key prefix.
static String	getProperty(JRPropertiesHolder propertiesHolder, String key) Deprecated. Returns the value of a property, looking first in the supplied properties holder and then in the system properties.
static String	getProperty(JRPropertiesMap propertiesMap, String key) Deprecated. Returns the value of a property, looking first in the supplied properties map and then in the system properties.
static String	getProperty(String key) Deprecated. Returns the value of the property.
static String	getProperty(String key, JRPropertiesHolder... propertiesHolders) Deprecated. Returns the value of a property, looking for it in several properties holders and then in the system properties.
protected static String	getSystemProperty(String propertyName) Deprecated.
protected static void	initProperties() Deprecated. Loads the properties.
static Properties	loadProperties(String name, Properties defaults) Deprecated. Loads a properties file from the classpath.
protected static void	loadSystemProperties() Deprecated.
protected static void	loadSystemProperty(String sysKey, String propKey) Deprecated.
static void	removePropertyValue(String key) Deprecated. Removes the value set for a property.
static void	restoreProperties() Deprecated. Restores previously saved properties.
static void	setProperty(String key, boolean value) Deprecated. Sets the value of a property.
static void	setProperty(String key, String value) Deprecated. Sets the value of a property.
protected static void	transfer(JRPropertiesMap source, JRPropertiesHolder destination, String tranferPropertiesPrefix) Deprecated.
static void	transferProperties(JRPropertiesHolder source, JRPropertiesHolder destination, String tranferPropertiesPrefix) Deprecated. Copies properties from one object to another.
static void	transferProperties(JRPropertiesMap source, JRPropertiesHolder destination, String tranferPropertiesPrefix) Deprecated. Copies properties from one object to another.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROPERTIES_FILE

protected static final String DEFAULT_PROPERTIES_FILE

Deprecated. Replaced by DefaultJasperReportsContext.DEFAULT_PROPERTIES_FILE.

The default properties file.

See Also:

Constant Field Values

PROPERTY_PREFIX

public static final String PROPERTY_PREFIX

Deprecated. Replaced by JRPropertiesUtil.PROPERTY_PREFIX.

The prefix used by all properties.

See Also:

Constant Field Values

PROPERTIES_FILE

public static final String PROPERTIES_FILE

Deprecated. Replaced by DefaultJasperReportsContext.PROPERTIES_FILE.

The name of the system property that specifies the properties file name.

See Also:

Constant Field Values

COMPILER_CLASS

public static final String COMPILER_CLASS

Deprecated. Replaced by JRCompiler.COMPILER_PREFIX.

The name of the class to be used for report compilation.

No default value.

See Also:

Constant Field Values

COMPILER_XML_VALIDATION

public static final String COMPILER_XML_VALIDATION

Deprecated. Replaced by JRReportSaxParserFactory.COMPILER_XML_VALIDATION.

Whether to validate the xml report when compiling.

Defaults to true.

See Also:

Constant Field Values

COMPILER_KEEP_JAVA_FILE

public static final String COMPILER_KEEP_JAVA_FILE

Deprecated. Replaced by JRCompiler.COMPILER_KEEP_JAVA_FILE.

Whether to keep the java file generated when the report is compiled.

Defaults to false.

See Also:

Constant Field Values

COMPILER_TEMP_DIR

public static final String COMPILER_TEMP_DIR

Deprecated. Replaced by JRCompiler.COMPILER_TEMP_DIR.

The temporary directory used by the report compiler.

Defaults to System.getProperty("user.dir").

See Also:

Constant Field Values

COMPILER_CLASSPATH

public static final String COMPILER_CLASSPATH

Deprecated. Replaced by JRCompiler.COMPILER_CLASSPATH.

The classpath used by the report compiler.

Defaults to System.getProperty("java.class.path").

See Also:

Constant Field Values

EXPORT_XML_VALIDATION

public static final String EXPORT_XML_VALIDATION

Deprecated. Replaced by PrintSaxParserFactory.EXPORT_XML_VALIDATION.

Validation flag used by the XML exporter.

Defaults to true.

See Also:

Constant Field Values

PDF_FONT_FILES_PREFIX

public static final String PDF_FONT_FILES_PREFIX

Deprecated. Replaced by JRPdfExporter.PDF_FONT_FILES_PREFIX.

Prefix of properties that specify font files for the PDF exporter.

See Also:

Constant Field Values

PDF_FONT_DIRS_PREFIX

public static final String PDF_FONT_DIRS_PREFIX

Deprecated. Replaced by JRPdfExporter.PDF_FONT_DIRS_PREFIX.

Prefix of properties that specify font directories for the PDF exporter.

See Also:

Constant Field Values

QUERY_EXECUTER_FACTORY_PREFIX

public static final String QUERY_EXECUTER_FACTORY_PREFIX

Deprecated. Replaced by net.sf.jasperreports.engine.query.

See Also:

Constant Field Values

properties

protected static volatile ConcurrentHashMap<String,String> properties

Deprecated.

savedProps

protected static HashMap<String,String> savedProps

Deprecated.

Method Detail

initProperties

protected static void initProperties()

Deprecated.

Loads the properties.

loadSystemProperties

protected static void loadSystemProperties()

Deprecated.

getDefaults

protected static Properties getDefaults()
                                 throws JRException

Deprecated.

Sets the default properties.

Returns:

the default properties

Throws:

JRException

getSystemProperty

protected static String getSystemProperty(String propertyName)

Deprecated.

loadSystemProperty

protected static void loadSystemProperty(String sysKey,
                      String propKey)

Deprecated.

loadProperties

public static Properties loadProperties(String name,
                        Properties defaults)
                                 throws JRException

Deprecated.

Loads a properties file from the classpath.

Parameters:

name - the resource name

defaults - the default properties

Returns:

the loaded properties if the resource is found, null otherwise

Throws:

JRException

getProperty

public static String getProperty(String key)

Deprecated.

Returns the value of the property.

Parameters:

key - the key

Returns:

the property value

getBooleanProperty

public static boolean getBooleanProperty(String key)

Deprecated.

Returns a property as a boolean value.

Parameters:

key - the key

Returns:

the property value as a boolean

getIntegerProperty

public static int getIntegerProperty(String key)

Deprecated.

Returns a property as an integer value.

Parameters:

key - the key

Returns:

the property value as an integer

getFloatProperty

public static float getFloatProperty(String key)

Deprecated.

Returns a property as a float value.

Parameters:

key - the key

Returns:

the property value as a float

asBoolean

public static boolean asBoolean(String value)

Deprecated.

Converts a String value into a boolean.

Parameters:

value - the value

Returns:

the value as a boolean

asInteger

public static int asInteger(String value)

Deprecated.

Converts a String value into a int.

Parameters:

value - the value

Returns:

the value as a int

asFloat

public static float asFloat(String value)

Deprecated.

Converts a String value into a float.

Parameters:

value - the value

Returns:

the value as a float

setProperty

public static void setProperty(String key,
               String value)

Deprecated.

Sets the value of a property.

Parameters:

key - the key

value - the value

setProperty

public static void setProperty(String key,
               boolean value)

Deprecated.

Sets the value of a property.

Parameters:

key - the key

value - the value

removePropertyValue

public static void removePropertyValue(String key)

Deprecated.

Removes the value set for a property.

This method removes values set in jasperreports.properties or via the setProperty method. Built-in default property values are not affected; if the property has a default value it will be used after calling this method for the property.

Parameters:

key - the property key

backupProperties

public static void backupProperties()

Deprecated.

Saves a copy of the current properties.

See Also:

restoreProperties()

restoreProperties

public static void restoreProperties()

Deprecated.

Restores previously saved properties.

See Also:

backupProperties()

getProperties

public static List<JRProperties.PropertySuffix> getProperties(String prefix)

Deprecated.

Returns the list of all properties for a key prefix.

Parameters:

prefix - the key prefix

Returns:

a list of PropertySuffix objects containing the suffix of the key and the value

getProperties

public static List<JRProperties.PropertySuffix> getProperties(JRPropertiesHolder propertiesHolder,
                                              String prefix)

Deprecated.

Returns the list of all properties for a key prefix. Only this holder's own properties are considered, and not global properties.

Parameters:

propertiesHolder - the properties holder

prefix - the key prefix

Returns:

a list of PropertySuffix objects containing the suffix of the key and the value

See Also:

getAllProperties(JRPropertiesHolder, String)

getAllProperties

public static List<JRProperties.PropertySuffix> getAllProperties(JRPropertiesHolder propertiesHolder,
                                                 String prefix)

Deprecated.

Returns the list of all properties for a key prefix, including global properties.

Parameters:

propertiesHolder - the properties holder

prefix - the key prefix

Returns:

a list of PropertySuffix objects containing the suffix of the key and the value

See Also:

getProperties(JRPropertiesHolder, String)

getProperties

public static List<JRProperties.PropertySuffix> getProperties(JRPropertiesMap propertiesMap,
                                              String prefix)

Deprecated.

Returns the list of all properties for a key prefix. Only properties from propertiesMap are considered, and not global properties.

Parameters:

propertiesMap - the properties map

prefix - the key prefix

Returns:

a list of PropertySuffix objects containing the suffix of the key and the value

See Also:

getAllProperties(JRPropertiesMap, String)

getAllProperties

public static List<JRProperties.PropertySuffix> getAllProperties(JRPropertiesMap propertiesMap,
                                                 String prefix)

Deprecated.

Returns the list of all properties for a key prefix, including global properties.

Parameters:

propertiesMap - the properties map

prefix - the key prefix

Returns:

a list of PropertySuffix objects containing the suffix of the key and the value

See Also:

getProperties(JRPropertiesMap, String)

getProperty

public static String getProperty(JRPropertiesHolder propertiesHolder,
                 String key)

Deprecated.

Returns the value of a property, looking first in the supplied properties holder and then in the system properties.

Parameters:

propertiesHolder - the properties holder

key - the key

Returns:

the property value

getProperty

public static String getProperty(String key,
                 JRPropertiesHolder... propertiesHolders)

Deprecated.

Returns the value of a property, looking for it in several properties holders and then in the system properties.

Parameters:

key - the key

propertiesHolders - the properties holders

Returns:

the property value

getProperty

public static String getProperty(JRPropertiesMap propertiesMap,
                 String key)

Deprecated.

Returns the value of a property, looking first in the supplied properties map and then in the system properties.

Parameters:

propertiesMap - the properties map

key - the key

Returns:

the property value

getBooleanProperty

public static boolean getBooleanProperty(JRPropertiesHolder propertiesHolder,
                         String key,
                         boolean defaultValue)

Deprecated.

Returns the value of a property as a boolean, looking first in the supplied properties holder and then in the system properties.

Parameters:

propertiesHolder - the properties holder

key - the key

defaultValue - the default value used if the property is not found

Returns:

the property value

getBooleanProperty

public static Boolean getBooleanProperty(JRPropertiesHolder propertiesHolder,
                         String key)

Deprecated.

Returns the value of a property as a Boolean object, looking first in the supplied properties holder and then in the system properties.

Parameters:

propertiesHolder - the properties holder

key - the key

Returns:

the property value or null if the property is not defined

getBooleanProperty

public static boolean getBooleanProperty(JRPropertiesMap propertiesMap,
                         String key,
                         boolean defaultValue)

Deprecated.

Returns the value of a property as a boolean, looking first in the supplied properties map and then in the system properties.

Parameters:

propertiesMap - the properties map

key - the key

defaultValue - the default value used if the property is not found

Returns:

the property value

getIntegerProperty

public static int getIntegerProperty(JRPropertiesHolder propertiesHolder,
                     String key,
                     int defaultValue)

Deprecated.

Returns the value of a property as an integer, looking first in the supplied properties holder and then in the system properties.

Parameters:

propertiesHolder - the properties holder

key - the key

defaultValue - the default value used if the property is not found

Returns:

the property value

getIntegerProperty

public static int getIntegerProperty(JRPropertiesMap propertiesMap,
                     String key,
                     int defaultValue)

Deprecated.

Returns the value of a property as an integer, looking first in the supplied properties map and then in the system properties.

Parameters:

propertiesMap - the properties map

key - the key

defaultValue - the default value used if the property is not found

Returns:

the property value

getIntegerProperty

public static int getIntegerProperty(String key,
                     int defaultValue)

Deprecated.

Returns the value of a property as an integer.

Parameters:

key - the key

defaultValue - the default value used if the property is not found

Returns:

the property value

getFloatProperty

public static float getFloatProperty(JRPropertiesHolder propertiesHolder,
                     String key,
                     float defaultValue)

Deprecated.

Returns the value of a property as a float, looking first in the supplied properties holder and then in the system properties.

Parameters:

propertiesHolder - the properties holder

key - the key

defaultValue - the default value used if the property is not found

Returns:

the property value

getFloatProperty

public static float getFloatProperty(JRPropertiesMap propertiesMap,
                     String key,
                     float defaultValue)

Deprecated.

Returns the value of a property as a float, looking first in the supplied properties map and then in the system properties.

Parameters:

propertiesMap - the properties map

key - the key

defaultValue - the default value used if the property is not found

Returns:

the property value

getFloatProperty

public static float getFloatProperty(String key,
                     float defaultValue)

Deprecated.

Returns the value of a property as a float.

Parameters:

key - the key

defaultValue - the default value used if the property is not found

Returns:

the property value

asLong

public static long asLong(String value)

Deprecated.

Converts a String value into a long.

Parameters:

value - the value

Returns:

the value as a long

getLongProperty

public static long getLongProperty(String key)

Deprecated.

Returns a property as a long value.

Parameters:

key - the key

Returns:

the property value as a long

getLongProperty

public static long getLongProperty(JRPropertiesMap propertiesMap,
                   String key,
                   int defaultValue)

Deprecated.

Returns the value of a property as a long, looking first in the supplied properties map and then in the system properties.

Parameters:

propertiesMap - the properties map

key - the key

defaultValue - the default value used if the property is not found

Returns:

the property value

getLongProperty

public static long getLongProperty(JRPropertiesHolder propertiesHolder,
                   String key,
                   int defaultValue)

Deprecated.

Returns the value of a property as a long, looking first in the supplied properties holder and then in the system properties.

Parameters:

propertiesHolder - the properties holder

key - the key

defaultValue - the default value used if the property is not found

Returns:

the property value

getOwnProperties

protected static JRPropertiesMap getOwnProperties(JRPropertiesHolder propertiesHolder)

Deprecated.

transferProperties

public static void transferProperties(JRPropertiesHolder source,
                      JRPropertiesHolder destination,
                      String tranferPropertiesPrefix)

Deprecated.

Copies properties from one object to another.

The properties to be copied are determined by one or more JasperReports properties having a specified prefix. The values of these properties are interpreted as prefixes of properties to copy.

Parameters:

source - the source properties holder

destination - the destination properties holder

tranferPropertiesPrefix - the prefix of the JasperReports properties that specify the object properties to copy

transferProperties

public static void transferProperties(JRPropertiesMap source,
                      JRPropertiesHolder destination,
                      String tranferPropertiesPrefix)

Deprecated.

Copies properties from one object to another.

Parameters:

source - the source properties

destination - the destination properties holder

tranferPropertiesPrefix - the prefix of the JasperReports properties that specify the object properties to copy

See Also:

transferProperties(JRPropertiesHolder, JRPropertiesHolder, String)

transfer

protected static void transfer(JRPropertiesMap source,
            JRPropertiesHolder destination,
            String tranferPropertiesPrefix)

Deprecated.

getCharacterProperty

public static Character getCharacterProperty(String key)

Deprecated.

Returns a property as a Character value.

Parameters:

key - the key

Returns:

the property value as a Character

See Also:

asCharacter(String)

getCharacterProperty

public static Character getCharacterProperty(JRPropertiesMap propertiesMap,
                             String key)

Deprecated.

Returns the value of a property as a Character value, looking first in the supplied properties holder and then in the system properties.

Parameters:

propertiesMap - the properties map

key - the key

Returns:

the property value as a Character

asCharacter

public static Character asCharacter(String value)

Deprecated.

Converts a String into a Character value.

If the String value is null or the empty string, null is returned. Otherwise, the method returns the first character in the string.

Parameters:

value - the String value

Returns:

the value converted to Character