Skip to main content
summaryrefslogtreecommitdiffstats
blob: 841965320f86e866f6ea094914eb51d2d1167cd6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<META name="GENERATOR" content="IBM Software Development Platform">
<link rel="STYLESHEET" href="../../book.css" charset="ISO-8859-1" type="text/css"/>
<TITLE>propertiesEncode XPath function</TITLE>
</HEAD>
<BODY>
<TABLE border="0" cellpadding="0" cellspacing="1" width="100%">
	<TBODY>
		<TR>
			<TH align="left"><P>propertiesEncode()</P></TH>
			<TH align="right"><A href="overview.html">Additional XPath Functions</A></TH>
		</TR>
	</TBODY>
</TABLE>
<HR>
<H2>propertiesEncode</H2>
<P>Reutnr a string encoded to conform to rules for Java properties files</P>
<HR>
<TABLE border="0" width="100%">
	<TBODY>
		<TR>
			<TH colspan="2" align="left">Function Summary<BR>&nbsp;</TH></TR>
		<TR>
			<TD width="20%" valign="top">minimal arguments</TD>
			<TD><SPAN style="font-family: monospace" valign="top">
			String propertiesEncode (String text)<BR>&nbsp;<BR>
			</SPAN></TD>
		</TR>
		<TR>
			<TD width="20%" valign="top">all arguments</TD>
			<TD><SPAN style="font-family: monospace" valign="top">
			String propertiesEncode (String text, boolean leadingSpacesOnly)<BR>&nbsp;<BR>
			</SPAN></TD>
		</TR>
	</TBODY>
</TABLE>
<HR>
<TABLE border="0" width="100%">
	<TBODY>
		<TR>
			<TH colspan="2" align="left">Required Arguments<BR>&nbsp;</TH>
        </TR>
		<TR>
			<TD width="20%" valign="top"><B>String text</B></TD>
			<TD>The text to be encoded. Should be either a key name or a property value.</TD>
		</TR>
	</TBODY>
</TABLE>
<HR>
<TABLE border="0" width="100%">
    <TBODY>
        <TR>
            <TH colspan="2" align="left">Optional Arguments<BR>&nbsp;</TH>
        </TR>
        <TR>
            <TD width="20%" valign="top"><B>boolean leadingSpacesOnly</B></TD>
            <TD>If <code>true</code>, then only leading spaces are encode (by adding a \). 
            The default is <code>false</code>. 
            For property value names, readability may be improved by specifying true().
            Note that property key names containing spaces should not be encoded with leadSpacesOnly set to true.
            </TD>
        </TR>
    </TBODY>
</TABLE>
<HR>
<TABLE border="0" width="100%">
	<TBODY>
		<TR>
			<TH colspan="2" align="left">Example<BR>&nbsp;</TH></TR>
		<TR>
			<TD colspan="2"><SPAN style="font-family: monospace">
<!-- Begin propertiesEncode example -->
			<B>propertiesEncode</B>(" a whole bunch of spaces ")<br>
			<P>returns the string "\ a\ whole\ bunch\ of\ spaces\ "</P>
            <B>propertiesEncode</B>(" a whole bunch of spaces ", true())<br>
            <P>returns the string "\ a whole bunch of spaces "</P>
<!-- End propertiesEncode example -->
</SPAN></TD>
		</TR>
	</TBODY>
</TABLE>
<P><BR>
<FONT color="navy" size="-2">&copy; Copyright IBM Corporation 
2008. All Rights Reserved.</FONT></P></P></BODY>
</HTML>

Back to the top