| java.lang.Object net.myvietnam.mvncore.configuration.AbstractConfiguration net.myvietnam.mvncore.configuration.BaseConfiguration net.myvietnam.mvncore.configuration.BasePathConfiguration net.myvietnam.mvncore.configuration.BasePropertiesConfiguration
All known Subclasses: net.myvietnam.mvncore.configuration.ClassPropertiesConfiguration, net.myvietnam.mvncore.configuration.PropertiesConfiguration,
BasePropertiesConfiguration | abstract public class BasePropertiesConfiguration extends BasePathConfiguration (Code) | | 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
author: Stefano Mazzocchi author: Jon S. Stevens author: Dave Bryson author: Geir Magnusson Jr. author: Leon Messerschmidt author: Kent Johnson author: Daniel Rall author: Ilkka Priha author: Jason van Zyl author: Martin Poeschl author: Henning P. Schmiedehausen version: $Id: BasePropertiesConfiguration.java,v 1.2 2003/12/10 04:30:45 minhnn Exp $ |
Inner Class :class PropertiesWriter extends FileWriter | |
Field Summary | |
protected static String | include This is the name of the property that can point to other
properties file for including other properties files. |
Method Summary | |
public String | getInclude() Gets the property value for including other properties files. | public boolean | getIncludesAllowed() Reports the status of file inclusion. | abstract protected InputStream | getPropertyStream(String resourceName) Implementations of this class must implement this method. | public void | load(InputStream input) Load the properties from the given input stream. | public synchronized void | load(InputStream input, String enc) Load the properties from the given input stream and using the specified
encoding. | public void | save(String filename) save properties to a file. | public void | setInclude(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. |
include | protected static String include(Code) | | This is the name of the property that can point to other
properties file for including other properties files.
|
getInclude | public String getInclude()(Code) | | Gets the property value for including other properties files.
By default it is "include".
A String. |
getIncludesAllowed | public boolean getIncludesAllowed()(Code) | | Reports the status of file inclusion.
True if include files are loaded. |
getPropertyStream | abstract protected InputStream getPropertyStream(String resourceName) throws IOException(Code) | | Implementations of this class must implement this method.
Parameters: resourceName - The Resource to load An Input Stream throws: IOException - Error while loading the properties file |
load | public synchronized void load(InputStream input, String enc) throws IOException(Code) | | Load the properties from the given input stream and using the specified
encoding.
Parameters: input - An InputStream. Parameters: enc - An encoding. exception: IOException - |
save | public void save(String filename) throws IOException(Code) | | save properties to a file.
properties with multiple values are saved comma seperated.
Parameters: filename - name of the properties file throws: IOException - |
setInclude | public void setInclude(String inc)(Code) | | Sets the property value for including other properties files.
By default it is "include".
Parameters: inc - A String. |
setIncludesAllowed | protected void setIncludesAllowed(boolean includesAllowed)(Code) | | Controls whether additional files can be loaded by the include =
statement or not. Base rule is, that objects created by the empty
C'tor can not have included files.
Parameters: includesAllowed - includesAllowed True if Includes are allowed. |
Methods inherited from net.myvietnam.mvncore.configuration.AbstractConfiguration | public void addProperty(String key, Object token)(Code)(Java Doc) abstract protected void addPropertyDirect(String key, Object obj)(Code)(Java Doc) abstract public void clearProperty(String key)(Code)(Java Doc) abstract public boolean containsKey(String key)(Code)(Java Doc) public boolean getBoolean(String key)(Code)(Java Doc) public boolean getBoolean(String key, boolean defaultValue)(Code)(Java Doc) public Boolean getBoolean(String key, Boolean defaultValue)(Code)(Java Doc) public byte getByte(String key)(Code)(Java Doc) public byte getByte(String key, byte defaultValue)(Code)(Java Doc) public Byte getByte(String key, Byte defaultValue)(Code)(Java Doc) public double getDouble(String key)(Code)(Java Doc) public double getDouble(String key, double defaultValue)(Code)(Java Doc) public Double getDouble(String key, Double defaultValue)(Code)(Java Doc) public float getFloat(String key)(Code)(Java Doc) public float getFloat(String key, float defaultValue)(Code)(Java Doc) public Float getFloat(String key, Float defaultValue)(Code)(Java Doc) public int getInt(String key)(Code)(Java Doc) public int getInt(String key, int defaultValue)(Code)(Java Doc) public Integer getInteger(String key, Integer defaultValue)(Code)(Java Doc) abstract public Iterator getKeys()(Code)(Java Doc) public Iterator getKeys(String prefix)(Code)(Java Doc) public long getLong(String key)(Code)(Java Doc) public long getLong(String key, long defaultValue)(Code)(Java Doc) public Long getLong(String key, Long defaultValue)(Code)(Java Doc) public Properties getProperties(String key)(Code)(Java Doc) public Properties getProperties(String key, Properties defaults)(Code)(Java Doc) public Object getProperty(String key)(Code)(Java Doc) abstract protected Object getPropertyDirect(String key)(Code)(Java Doc) public short getShort(String key)(Code)(Java Doc) public short getShort(String key, short defaultValue)(Code)(Java Doc) public Short getShort(String key, Short defaultValue)(Code)(Java Doc) public String getString(String key)(Code)(Java Doc) public String getString(String key, String defaultValue)(Code)(Java Doc) public String[] getStringArray(String key)(Code)(Java Doc) public Vector getVector(String key)(Code)(Java Doc) public Vector getVector(String key, Vector defaultValue)(Code)(Java Doc) protected String interpolate(String base)(Code)(Java Doc) protected String interpolateHelper(String base, List priorVariables)(Code)(Java Doc) abstract public boolean isEmpty()(Code)(Java Doc) protected List processString(String token)(Code)(Java Doc) public void setProperty(String key, Object value)(Code)(Java Doc) public Configuration subset(String prefix)(Code)(Java Doc) final protected Boolean testBoolean(String value)(Code)(Java Doc)
|
|
|