Save This Page
Home » spring-framework-2.5.5-with-dependencies » org.springframework » core » io » support » [javadoc | source]
org.springframework.core.io.support
abstract public class: PropertiesLoaderSupport [javadoc | source]
java.lang.Object
   org.springframework.core.io.support.PropertiesLoaderSupport

Direct Known Subclasses:
    PropertiesFactoryBean, PropertyPlaceholderConfigurer, ResourceMapFactoryBean, ServletContextPropertyPlaceholderConfigurer, PropertyResourceConfigurer, PropertyOverrideConfigurer, PreferencesPlaceholderConfigurer

Base class for JavaBean-style components that need to load properties from one or more resources. Supports local properties as well, with configurable overriding.
Field Summary
public static final  String XML_FILE_EXTENSION     
protected final  Log logger    Logger available to subclasses 
Method from org.springframework.core.io.support.PropertiesLoaderSupport Summary:
loadProperties,   mergeProperties,   setFileEncoding,   setIgnoreResourceNotFound,   setLocalOverride,   setLocation,   setLocations,   setProperties,   setPropertiesArray,   setPropertiesPersister
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.springframework.core.io.support.PropertiesLoaderSupport Detail:
 protected  void loadProperties(Properties props) throws IOException 
    Load properties into the given instance.
 protected Properties mergeProperties() throws IOException 
    Return a merged Properties instance containing both the loaded properties and properties set on this FactoryBean.
 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.

 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".

 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.

 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.

 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.

    Note: Properties defined in later files will override properties defined earlier files, in case of overlapping keys. Hence, make sure that the most specific files are the last ones in the given list of locations.

 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.
 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.
 public  void setPropertiesPersister(PropertiesPersister propertiesPersister) 
    Set the PropertiesPersister to use for parsing properties files. The default is DefaultPropertiesPersister.