org.opencms.configuration

类 CmsParameterConfiguration

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.String>

org.opencms.configuration.CmsParameterConfiguration

所有已实现的接口:

java.util.Map<java.lang.String,java.lang.String>

public class CmsParameterConfiguration
extends java.util.AbstractMap<java.lang.String,java.lang.String>

Provides convenient access to configuration parameters.

Usually the parameters are configured in some sort of String based file, either in an XML configuration, or in a .property file. This wrapper allows accessing such String values directly as int, boolean or other data types, without worrying about the type conversion.

It can also read a configuration from a special property file format, which is explained here:

• Each parameter in the file 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.
• Backslashes are escaped by using two consecutive backslashes i.e. \\. Note: Unlike in regular Java properties files, you don't need to escape Backslashes.
• If a key is used more than once, the values are appended as if they were on the same line separated with commas.
• Blank lines and lines starting with character '#' are skipped.

Here is an example of a valid parameter 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.escaped = Hi\, what'up?
 

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static class	CmsParameterConfiguration.ParameterReader Used to read parameter lines from a property file.
protected static class	CmsParameterConfiguration.ParameterTokenizer This class divides property value into tokens separated by ",".

从类继承的嵌套类/接口 java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

从接口继承的嵌套类/接口 java.util.Map

java.util.Map.Entry<K,V>

字段概要

字段

限定符和类型	字段和说明
static CmsParameterConfiguration	EMPTY_PARAMETERS An empty, immutable parameter configuration.

构造器概要

构造器

构造器和说明
CmsParameterConfiguration() Creates an empty parameter configuration.
CmsParameterConfiguration(java.io.InputStream in) Creates a parameter configuration from an input stream.
CmsParameterConfiguration(java.util.Map<java.lang.String,java.lang.String> configuration) Creates a parameter configuration from a Map of Strings.
CmsParameterConfiguration(java.lang.String file) Creates a parameter wrapper by loading the parameters from the specified property file.

方法概要

方法

限定符和类型	方法和说明
void	add(java.lang.String key, java.lang.String value) Add a parameter to this configuration.
org.dom4j.Element	appendToXml(org.dom4j.Element parentNode) Serializes this parameter configuration for the OpenCms XML configuration.
org.dom4j.Element	appendToXml(org.dom4j.Element parentNode, java.util.List<java.lang.String> parametersToIgnore) Serializes this parameter configuration for the OpenCms XML configuration.
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
protected static int	countPreceding(java.lang.String line, int index, char ch) Counts the number of successive times 'ch' appears in the 'line' before the position indicated by the 'index'.
protected static boolean	endsWithSlash(java.lang.String line) Checks if the line ends with odd number of backslashes.
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	entrySet()
java.lang.String	get(java.lang.Object key) Returns the String associated with the given parameter.
boolean	getBoolean(java.lang.String key, boolean defaultValue) Returns the boolean associated with the given parameter, or the default value in case there is no boolean value for this parameter.
int	getInteger(java.lang.String key, int defaultValue) Returns the integer associated with the given parameter, or the default value in case there is no integer value for this parameter.
java.util.List<java.lang.String>	getList(java.lang.String key) Returns the List of Strings associated with the given parameter, or an empty List in case there is no List of Strings for this parameter.
java.util.List<java.lang.String>	getList(java.lang.String key, java.util.List<java.lang.String> defaultValue) Returns the List of Strings associated with the given parameter, or the default value in case there is no List of Strings for this parameter.
java.lang.Object	getObject(java.lang.String key) Returns the raw Object associated with the given parameter, or null in case there is no Object for this parameter.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Returns the String associated with the given parameter, or the given default value in case there is no value for this parameter.
int	hashCode()
java.util.Set<java.lang.String>	keySet()
void	load(java.io.InputStream input) Load the parameters from the given input stream, which must be in property file format.
java.lang.String	put(java.lang.String key, java.lang.String value) Set a parameter for this configuration.
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> other) Merges this parameter configuration with the provided other parameter configuration.
java.lang.String	remove(java.lang.Object key) Removes a parameter from this configuration.
java.lang.String	toString()
protected static java.lang.String	unescape(java.lang.String value) Replaces escaped char sequences in the input value.
static CmsParameterConfiguration	unmodifiableVersion(CmsParameterConfiguration original) Returns an unmodifiable version of this parameter configuration.
java.util.Collection<java.lang.String>	values()

从类继承的方法 java.util.AbstractMap

clone, equals, isEmpty, size

从类继承的方法 java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料

EMPTY_PARAMETERS

public static final CmsParameterConfiguration EMPTY_PARAMETERS

An empty, immutable parameter configuration.

构造器详细资料

CmsParameterConfiguration

public CmsParameterConfiguration()

Creates an empty parameter configuration.

CmsParameterConfiguration

public CmsParameterConfiguration(java.io.InputStream in)
                          throws java.io.IOException

Creates a parameter configuration from an input stream.

参数:

in - the input stream to create the parameter configuration from

抛出:

java.io.IOException - in case of errors loading the parameters from the input stream

CmsParameterConfiguration

public CmsParameterConfiguration(java.util.Map<java.lang.String,java.lang.String> configuration)

Creates a parameter configuration from a Map of Strings.

参数:

configuration - the map of Strings to create the parameter configuration from

CmsParameterConfiguration

public CmsParameterConfiguration(java.lang.String file)
                          throws java.io.IOException

Creates a parameter wrapper by loading the parameters from the specified property file.

参数:

file - the path of the file to load

抛出:

java.io.IOException - in case of errors loading the parameters from the specified property file

方法详细资料

unmodifiableVersion

public static CmsParameterConfiguration unmodifiableVersion(CmsParameterConfiguration original)

Returns an unmodifiable version of this parameter configuration.

参数:

original - the configuration to make unmodifiable

返回:

an unmodifiable version of this parameter configuration

countPreceding

protected static int countPreceding(java.lang.String line,
                 int index,
                 char ch)

Counts the number of successive times 'ch' appears in the 'line' before the position indicated by the 'index'.

参数:

line - the line to count

index - the index position to start

ch - the character to count

返回:

the number of successive times 'ch' appears in the 'line' before the position indicated by the 'index'

endsWithSlash

protected static boolean endsWithSlash(java.lang.String line)

Checks if the line ends with odd number of backslashes.

参数:

line - the line to check

返回:

true if the line ends with odd number of backslashes

unescape

protected static java.lang.String unescape(java.lang.String value)

Replaces escaped char sequences in the input value.

参数:

value - the value to unescape

返回:

the unescaped String

add

public void add(java.lang.String key,
       java.lang.String value)

Add a parameter to this configuration.

If the parameter already exists then the value will be added to the existing configuration entry and a List will be created for the values.

String values separated by a comma "," will NOT be tokenized when this method is used. To create a List of String values for a parameter, call this method multiple times with the same parameter name.

参数:

key - the parameter to add

value - the value to add

appendToXml

public org.dom4j.Element appendToXml(org.dom4j.Element parentNode)

Serializes this parameter configuration for the OpenCms XML configuration.

For each parameter, a XML node like this
<param name="theName">theValue</param>
is generated and appended to the provided parent node.

参数:

parentNode - the parent node where the parameter nodes are appended to

返回:

the parent node

appendToXml

public org.dom4j.Element appendToXml(org.dom4j.Element parentNode,
                            java.util.List<java.lang.String> parametersToIgnore)

Serializes this parameter configuration for the OpenCms XML configuration.

For each parameter, a XML node like this
<param name="theName">theValue</param>
is generated and appended to the provided parent node.

参数:

parentNode - the parent node where the parameter nodes are appended to

parametersToIgnore - if not null, all parameters in this list are not written to the XML

返回:

the parent node

clear

public void clear()

指定者:

clear 在接口中 java.util.Map<java.lang.String,java.lang.String>

覆盖:

clear 在类中 java.util.AbstractMap<java.lang.String,java.lang.String>

另请参阅:

Map.clear()

containsKey

public boolean containsKey(java.lang.Object key)

指定者:

containsKey 在接口中 java.util.Map<java.lang.String,java.lang.String>

覆盖:

containsKey 在类中 java.util.AbstractMap<java.lang.String,java.lang.String>

另请参阅:

Map.containsKey(java.lang.Object)

containsValue

public boolean containsValue(java.lang.Object value)

指定者:

containsValue 在接口中 java.util.Map<java.lang.String,java.lang.String>

覆盖:

containsValue 在类中 java.util.AbstractMap<java.lang.String,java.lang.String>

另请参阅:

Map.containsValue(java.lang.Object)

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> entrySet()

指定者:

entrySet 在接口中 java.util.Map<java.lang.String,java.lang.String>

指定者:

entrySet 在类中 java.util.AbstractMap<java.lang.String,java.lang.String>

另请参阅:

Map.entrySet()

get

public java.lang.String get(java.lang.Object key)

Returns the String associated with the given parameter.

指定者:

get 在接口中 java.util.Map<java.lang.String,java.lang.String>

覆盖:

get 在类中 java.util.AbstractMap<java.lang.String,java.lang.String>

参数:

key - the parameter to look up the value for

返回:

the String associated with the given parameter

getBoolean

public boolean getBoolean(java.lang.String key,
                 boolean defaultValue)

Returns the boolean associated with the given parameter, or the default value in case there is no boolean value for this parameter.

参数:

key - the parameter to look up the value for

defaultValue - the default value

返回:

the boolean associated with the given parameter, or the default value in case there is no boolean value for this parameter

getInteger

public int getInteger(java.lang.String key,
             int defaultValue)

Returns the integer associated with the given parameter, or the default value in case there is no integer value for this parameter.

参数:

key - the parameter to look up the value for

defaultValue - the default value

返回:

the integer associated with the given parameter, or the default value in case there is no integer value for this parameter

getList

public java.util.List<java.lang.String> getList(java.lang.String key)

Returns the List of Strings associated with the given parameter, or an empty List in case there is no List of Strings for this parameter.

The list returned is a copy of the internal data of this object, and as such you may alter it freely.

参数:

key - the parameter to look up the value for

返回:

the List of Strings associated with the given parameter, or an empty List in case there is no List of Strings for this parameter

getList

public java.util.List<java.lang.String> getList(java.lang.String key,
                                       java.util.List<java.lang.String> defaultValue)

Returns the List of Strings associated with the given parameter, or the default value in case there is no List of Strings for this parameter.

The list returned is a copy of the internal data of this object, and as such you may alter it freely.

参数:

key - the parameter to look up the value for

defaultValue - the default value

返回:

the List of Strings associated with the given parameter, or the default value in case there is no List of Strings for this parameter

getObject

public java.lang.Object getObject(java.lang.String key)

Returns the raw Object associated with the given parameter, or null in case there is no Object for this parameter.

参数:

key - the parameter to look up the value for

返回:

the raw Object associated with the given parameter, or null in case there is no Object for this parameter.

getString

public java.lang.String getString(java.lang.String key,
                         java.lang.String defaultValue)

Returns the String associated with the given parameter, or the given default value in case there is no value for this parameter.

参数:

key - the parameter to look up the value for

defaultValue - the default value

返回:

the String associated with the given parameter, or the given default value in case there is no value for this parameter.

hashCode

public int hashCode()

指定者:

hashCode 在接口中 java.util.Map<java.lang.String,java.lang.String>

覆盖:

hashCode 在类中 java.util.AbstractMap<java.lang.String,java.lang.String>

另请参阅:

Map.hashCode()

keySet

public java.util.Set<java.lang.String> keySet()

指定者:

keySet 在接口中 java.util.Map<java.lang.String,java.lang.String>

覆盖:

keySet 在类中 java.util.AbstractMap<java.lang.String,java.lang.String>

另请参阅:

Map.keySet()

load

public void load(java.io.InputStream input)
          throws java.io.IOException

Load the parameters from the given input stream, which must be in property file format.

参数:

input - the stream to load the input from

抛出:

java.io.IOException - in case of IO errors reading from the stream

put

public java.lang.String put(java.lang.String key,
                   java.lang.String value)

Set a parameter for this configuration.

If the parameter already exists then the existing value will be replaced.

指定者:

put 在接口中 java.util.Map<java.lang.String,java.lang.String>

覆盖:

put 在类中 java.util.AbstractMap<java.lang.String,java.lang.String>

参数:

key - the parameter to set

value - the value to set

返回:

the previous String value from the parameter map

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> other)

Merges this parameter configuration with the provided other parameter configuration.

The difference form a simple Map<String, String> is that for the parameter configuration, the values of the keys in both maps are merged and kept in the Object store as a List.

As result, this configuration will be altered, the other configuration will stay unchanged.

指定者:

putAll 在接口中 java.util.Map<java.lang.String,java.lang.String>

覆盖:

putAll 在类中 java.util.AbstractMap<java.lang.String,java.lang.String>

参数:

other - the other parameter configuration to merge this configuration with

remove

public java.lang.String remove(java.lang.Object key)

Removes a parameter from this configuration.

指定者:

remove 在接口中 java.util.Map<java.lang.String,java.lang.String>

覆盖:

remove 在类中 java.util.AbstractMap<java.lang.String,java.lang.String>

参数:

key - the parameter to remove

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.util.AbstractMap<java.lang.String,java.lang.String>

另请参阅:

java.util.Map#toString()

values

public java.util.Collection<java.lang.String> values()

指定者:

values 在接口中 java.util.Map<java.lang.String,java.lang.String>

覆盖:

values 在类中 java.util.AbstractMap<java.lang.String,java.lang.String>

另请参阅:

Map.values()