PropertiesLoaderSupport (Spring Framework API 2.1) - Spring Framework 2.1.0 API 文档英文版

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

The Spring Framework

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.core.io.support
Class PropertiesLoaderSupport

java.lang.Object
  org.springframework.core.io.support.PropertiesLoaderSupport

Direct Known Subclasses:: PropertiesFactoryBean, PropertyResourceConfigurer

public abstract class PropertiesLoaderSupport
extends Object
extends Object

Base class for JavaBean-style components that need to load properties from one or more resources. Supports local properties as well, with configurable overriding.

Since:: 1.2.2
Author:: Juergen Hoeller

Field Summary

protected Log logger
          Logger available to subclasses

static String XML_FILE_EXTENSION


Constructor Summary

PropertiesLoaderSupport()


Method Summary

protected void loadProperties(Properties props)
          Load properties into the given instance.

protected Properties mergeProperties()
          Return a merged Properties instance containing both the loaded properties and properties set on this FactoryBean.

void setFileEncoding(String encoding)
          Set the encoding to use for parsing properties files.

void setIgnoreResourceNotFound(boolean ignoreResourceNotFound)
          Set if failure to find the property resource should be ignored.

void setLocalOverride(boolean localOverride)
          Set whether local properties override properties from files.

void setLocation(Resource location)
          Set a location of a properties file to be loaded.

void setLocations(Resource[] locations)
          Set locations of properties files to be loaded.

void setProperties(Properties properties)
          Set local properties, e.g. via the "props" tag in XML bean definitions.

void setPropertiesArray(Properties[] propertiesArray)
          Set local properties, e.g. via the "props" tag in XML bean definitions, allowing for merging multiple properties sets into one.

void setPropertiesPersister(PropertiesPersister propertiesPersister)
          Set the PropertiesPersister to use for parsing properties files.

Methods inherited from class java.lang.Object

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

Field Summary
`protected Log`	`logger` Logger available to subclasses
`static String`	`XML_FILE_EXTENSION`

Constructor Summary
`PropertiesLoaderSupport()`

Method Summary
`protected void`	`loadProperties(Properties props)` Load properties into the given instance.
`protected Properties`	`mergeProperties()` Return a merged Properties instance containing both the loaded properties and properties set on this FactoryBean.
`void`	`setFileEncoding(String encoding)` Set the encoding to use for parsing properties files.
`void`	`setIgnoreResourceNotFound(boolean ignoreResourceNotFound)` Set if failure to find the property resource should be ignored.
`void`	`setLocalOverride(boolean localOverride)` Set whether local properties override properties from files.
`void`	`setLocation(Resource location)` Set a location of a properties file to be loaded.
`void`	`setLocations(Resource[] locations)` Set locations of properties files to be loaded.
`void`	`setProperties(Properties properties)` Set local properties, e.g. via the "props" tag in XML bean definitions.
`void`	`setPropertiesArray(Properties[] propertiesArray)` Set local properties, e.g. via the "props" tag in XML bean definitions, allowing for merging multiple properties sets into one.
`void`	`setPropertiesPersister(PropertiesPersister propertiesPersister)` Set the PropertiesPersister to use for parsing properties files.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

XML_FILE_EXTENSION

public static final String XML_FILE_EXTENSION

See Also:: Constant Field Values

logger

protected final Log logger

Logger available to subclasses

Constructor Detail

PropertiesLoaderSupport

public PropertiesLoaderSupport()

Method Detail

setProperties

public void setProperties(Properties properties)

Set local properties, e.g. via the "props" tag in XML bean definitions. These can be considered defaults, to be overridden by properties loaded from files.

setPropertiesArray

public void setPropertiesArray(Properties[] propertiesArray)

Set local properties, e.g. via the "props" tag in XML bean definitions, allowing for merging multiple properties sets into one.

setLocation

public void setLocation(Resource location)

Set a location of a properties file to be loaded.

Can point to a classic properties file or to an XML file that follows JDK 1.5's properties XML format.

setLocations

public void setLocations(Resource[] locations)

Set locations of properties files to be loaded.

Can point to classic properties files or to XML files that follow JDK 1.5's properties XML format.

setLocalOverride

public void setLocalOverride(boolean localOverride)

Set whether local properties override properties from files. Default is "false": properties from files override local defaults. Can be switched to "true" to let local properties override defaults from files.

setIgnoreResourceNotFound

public void setIgnoreResourceNotFound(boolean ignoreResourceNotFound)

Set if failure to find the property resource should be ignored. True is appropriate if the properties file is completely optional. Default is "false".

setFileEncoding

public void setFileEncoding(String encoding)

Set the encoding to use for parsing properties files.

Default is none, using the java.util.Properties default encoding.

Only applies to classic properties files, not to XML files.

See Also:: PropertiesPersister.load(java.util.Properties, java.io.InputStream)

setPropertiesPersister

public void setPropertiesPersister(PropertiesPersister propertiesPersister)

Set the PropertiesPersister to use for parsing properties files. The default is DefaultPropertiesPersister.

See Also:: DefaultPropertiesPersister

mergeProperties

protected Properties mergeProperties()
                              throws IOException

Return a merged Properties instance containing both the loaded properties and properties set on this FactoryBean.

Throws:: IOException

loadProperties

protected void loadProperties(Properties props)
                       throws IOException

Load properties into the given instance.

Parameters:: props - the Properties instance to load into
Throws:: IOException - in case of I/O errors
See Also:: setLocations(org.springframework.core.io.Resource[])