BasePropertiesConfiguration

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.configuration
Class BasePropertiesConfiguration

java.lang.Object
  org.apache.commons.configuration.AbstractConfiguration
      org.apache.commons.configuration.BaseConfiguration
          org.apache.commons.configuration.BasePathConfiguration
              org.apache.commons.configuration.BasePropertiesConfiguration

All Implemented Interfaces:: BasePathLoader, Configuration

Direct Known Subclasses:: ClassPropertiesConfiguration, PropertiesConfiguration

public abstract class BasePropertiesConfiguration
extends BasePathConfiguration

loads the configuration from a properties file.

The properties file syntax is explained here:

Each property has the syntax key = value
The key may use any character but the equal sign '='.
value may be separated on different lines if a backslash is placed at the end of the line that continues below.
If value is a list of strings, each token is separated by a comma ','.
Commas in each token are escaped placing a backslash right before the comma.
If a key is used more than once, the values are appended like if they were on the same line separated with commas.
Blank lines and lines starting with character '#' are skipped.
If a property is named "include" (or whatever is defined by setInclude() and getInclude() and the value of that property is the full path to a file on disk, that file will be included into the ConfigurationsRepository. You can also pull in files relative to the parent configuration file. So if you have something like the following: include = additional.properties Then "additional.properties" is expected to be in the same directory as the parent configuration file. Duplicate name values will be replaced, so be careful.

Here is an example of a valid extended properties file:

      # lines starting with # are comments

      # This is the simplest property
      key = value

      # A long property may be separated on multiple lines
      longvalue = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \
                  aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

      # This is a property with many tokens
      tokens_on_a_line = first token, second token

      # This sequence generates exactly the same result
      tokens_on_multiple_lines = first token
      tokens_on_multiple_lines = second token

      # commas may be escaped in tokens
      commas.excaped = Hi\, what'up?
 
      # properties can reference other properties
      base.prop = /base
      first.prop = ${base.prop}/first
      second.prop = ${first.prop}/second

Version:: $Id: BasePropertiesConfiguration.java,v 1.1.1.1 2003/12/23 15:09:05 epugh Exp $
Author:: Stefano Mazzocchi, Jon S. Stevens, Dave Bryson, Geir Magnusson Jr., Leon Messerschmidt, Kent Johnson, Daniel Rall, Ilkka Priha, Jason van Zyl, Martin Poeschl, Henning P. Schmiedehausen

Nested Class Summary
`(package private) class`	`BasePropertiesConfiguration.PropertiesReader` This class is used to read properties lines.
`(package private) class`	`BasePropertiesConfiguration.PropertiesWriter` This class is used to write properties lines.

Nested classes inherited from class org.apache.commons.configuration.AbstractConfiguration

AbstractConfiguration.Container, AbstractConfiguration.PropertiesTokenizer

Field Summary
`protected static java.lang.String`	`include` This is the name of the property that can point to other properties file for including other properties files.
`private boolean`	`includesAllowed` Allow file inclusion or not

Fields inherited from class org.apache.commons.configuration.BasePathConfiguration

Fields inherited from class org.apache.commons.configuration.BaseConfiguration

Fields inherited from class org.apache.commons.configuration.AbstractConfiguration

defaults, END_TOKEN, START_TOKEN

Constructor Summary
`BasePropertiesConfiguration()`

Method Summary
`java.lang.String`	`getInclude()` Gets the property value for including other properties files.
`boolean`	`getIncludesAllowed()` Reports the status of file inclusion.
`protected abstract java.io.InputStream`	`getPropertyStream(java.lang.String resourceName)` Implementations of this class must implement this method.
`void`	`load(java.io.InputStream input)` Load the properties from the given input stream.
`void`	`load(java.io.InputStream input, java.lang.String enc)` Load the properties from the given input stream and using the specified encoding.
`void`	`save(java.lang.String filename)` save properties to a file.
`void`	`setInclude(java.lang.String inc)` Sets the property value for including other properties files.
`protected void`	`setIncludesAllowed(boolean includesAllowed)` Controls whether additional files can be loaded by the include = statement or not.

Methods inherited from class org.apache.commons.configuration.BasePathConfiguration

getBasePath, setBasePath

Methods inherited from class org.apache.commons.configuration.BaseConfiguration

addPropertyDirect, clearProperty, containsKey, getKeys, getPropertyDirect, isEmpty

Methods inherited from class org.apache.commons.configuration.AbstractConfiguration

addProperty, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getKeys, getList, getList, getLong, getLong, getLong, getProperties, getProperties, getProperty, getShort, getShort, getShort, getString, getString, getStringArray, interpolate, interpolateHelper, processString, setProperty, subset, testBoolean

Methods inherited from class java.lang.Object

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

Field Detail

includesAllowed

private boolean includesAllowed

Allow file inclusion or not

include

protected static java.lang.String include

This is the name of the property that can point to other properties file for including other properties files.

Constructor Detail