Java Doc for Maps.java in  » Ajax » zk » org » zkoss » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Like java.util.Properties, it translates \\u, \n, \r, \t and \f. However, it enhanced Properties as follows.

• It accepts any charset, not just 8859-1.
• It uses a different syntax to let value spread over multiple lines, descrubed below.
• Whitespace is trimmed around '=' and at the beginning of the key and the ending of the value.
• Illegal lines are ignored (Properties.load considers it as a key with an empty value).
• Only '=' is accepted as the separator of key and value.
• Only '#' is accepted as comment lines.

To spead a value over multiple lines, you could, unlike java.util.Properties.load, append '{' to the end of a line. Then, all the following lines are considerred as part of a value, unless encountering a line containing only one '}'.
Example:

abc = {
 line 1
 line 2
 }
 xyz = {
 line 1
 line 2
 }

Moreover, you could prefix a group of keys with certain prefix:

org.zkoss.some.

For example, if the following string is parsed:
a12=12,b3,c6=abc=125,x=y

Then, a map with the following content is returned:
("a12", "12"), ("b3", null), ("c6", "abc=125"), ("x", "y")

If = is omitted, it is considered as a key with the null value. If you want to consider it as the value, use Maps.parse(Map,String,char,char,boolean) instead. Actually, this is the same as parse(map, src, separator, quote, false);

Notice: only the first = after separator is meaningful, so you don't have to escape the following =.

Beside specifying the quote character, you could use back slash quote a single character (as Java does).
Parameters:
  map - the map to put parsed results to; null to create anew hash map
Parameters:
  src - the string to parse
Parameters:
  separator - the separator, e.g., ' ' or ','.
Parameters:
  quote - the quote character to surrounding value, e.g.,name = 'value'.

If = is omitted, whether it is considered as a key with the null value or a value with the null key depends on the asValue argument.

Like java.util.Properties, it translates \\u, \n, \r, \t and \f. However, it enhanced Properties as follows.

• It accepts any charset, not just 8859-1.
• It uses a different syntax to let value spread over multiple lines, descrubed below.
• Whitespace is trimmed around '=' and at the beginning of the key and the ending of the value.
• Illegal lines are ignored (Properties.load considers it as a key with an empty value).
• Only '=' is accepted as the separator of key and value.
• Only '#' is accepted as comment lines.

To spead a value over multiple lines, you could, unlike java.util.Properties.load, append '{' to the end of a line. Then, all the following lines are considerred as part of a value, unless encountering a line containing only one '}'.
Example:

abc = {
 line 1
 line 2
 }
 xyz = {
 line 1
 line 2
 }

Moreover, you could prefix a group of keys with certain prefix:

org.zkoss.some. {
 a = aaa
 b = bbb
 }

Note: (1) whitespace in the {...} block are all preserved.
(2) if only whitespaces is between '=' and '{', they are ignored.
Parameters:
  charset - the charset; if null, it detects UTF-16 BOM (0xfe 0xffor 0xff 0xfe). If no UTF-16 BOM, UTF-8 is always assumed.Note 1: UTF-8's BOM (0xef 0xbb 0xbf) is optional, so we don't count on it.Note 2: ISO-8859-1 is not used because we cannot tell its differencefrom UTF-8 (while some of our properties files are in UTF-8).
Parameters:
  caseInsensitive - whether the key used to access the mapis case-insensitive. If true, all keys are converted to lower cases.

For example, if the following string is parsed:
a12=12,b3,c6=abc=125,x=y

Then, a map with the following content is returned:
("a12", "12"), ("b3", null), ("c6", "abc=125"), ("x", "y")

If = is omitted, it is considered as a key with the null value. If you want to consider it as the value, use Maps.parse(Map,String,char,char,boolean) instead. Actually, this is the same as parse(map, src, separator, quote, false);

Notice: only the first = after separator is meaningful, so you don't have to escape the following =.

Beside specifying the quote character, you could use back slash quote a single character (as Java does).
Parameters:
  map - the map to put parsed results to; null to create anew hash map
Parameters:
  src - the string to parse
Parameters:
  separator - the separator, e.g., ' ' or ','.
Parameters:
  quote - the quote character to surrounding value, e.g.,name = 'value'. If (char)0, no quotation is recognized.Notice: if value is an expression, it is better to specify (char)0because expression might contain strings. the map being generated
exception:
  IllegalSyntaxException - if syntax errors
See Also:   CollectionsX.parse
See Also:   Maps.toString(Map,char,char)

If = is omitted, whether it is considered as a key with the null value or a value with the null key depends on the asValue argument. If true, it is considered as a value with the null key.

For example, if the following string is parsed with asValue=false:
a12=12,b3,c6=abc=125,x=y

Then, a map with the following content is returned:
("a12", "12"), ("b3", null), ("c6", "abc=125"), ("x", "y")

Notice: only the first = after separator is meaningful, so you don't have to escape the following =.

Beside specifying the quote character, you could use back slash quote a single character (as Java does).
Parameters:
  map - the map to put parsed results to; null to create anew hash map
Parameters:
  src - the string to parse
Parameters:
  separator - the separator, e.g., ' ' or ','.
Parameters:
  quote - the quote character to surrounding value, e.g.,name = 'value'. If (char)0, no quotation is recognized.Notice: if value is an expression, it is better to specify (char)0because expression might contain strings.
Parameters:
  asValue - whether to consider the substring without = asa value (with the null key), or as a key (with the null value) the map being generated
exception:
  IllegalSyntaxException - if syntax errors
See Also:   CollectionsX.parse
See Also:   Maps.toString(Map,char,char)
since:
   2.4.0