| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!--NewPage--> | |
| <HTML> | |
| <HEAD> | |
| <!-- Generated by javadoc (build 1.5.0_14) on Mon Apr 26 10:16:13 PDT 2010 --> | |
| <TITLE> | |
| EscapeTool (VelocityTools 2.0 Documentation) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.EscapeTool class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="EscapeTool (VelocityTools 2.0 Documentation)"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <A NAME="navbar_top"><!-- --></A> | |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_top_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.Measurements.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/generic/FieldTool.html" title="class in org.apache.velocity.tools.generic"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/EscapeTool.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="EscapeTool.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_top"></A> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <HR> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <H2> | |
| <FONT SIZE="-1"> | |
| org.apache.velocity.tools.generic</FONT> | |
| <BR> | |
| Class EscapeTool</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.SafeConfig</A> | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.EscapeTool</B> | |
| </PRE> | |
| <HR> | |
| <DL> | |
| <DT><PRE><FONT SIZE="-1"><A HREF="../../../../../org/apache/velocity/tools/config/DefaultKey.html" title="annotation in org.apache.velocity.tools.config">@DefaultKey</A>(<A HREF="../../../../../org/apache/velocity/tools/config/DefaultKey.html#value()">value</A>="esc") | |
| </FONT>public class <B>EscapeTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></DL> | |
| </PRE> | |
| <P> | |
| Tool for working with escaping in Velocity templates. | |
| It provides methods to escape outputs for Velocity, Java, JavaScript, HTML, HTTP, XML and SQL. | |
| Also provides methods to render VTL characters that otherwise needs escaping. | |
| <p><pre> | |
| Example uses: | |
| $velocity -> Please escape $ and #! | |
| $esc.velocity($velocity) -> Please escape ${esc.d} and ${esc.h}! | |
| $java -> He didn't say, "Stop!" | |
| $esc.java($java) -> He didn't say, \"Stop!\" | |
| $javascript -> He didn't say, "Stop!" | |
| $esc.javascript($javascript) -> He didn\'t say, \"Stop!\" | |
| $html -> "bread" & "butter" | |
| $esc.html($html) -> &quot;bread&quot; &amp; &quot;butter&quot; | |
| $xml -> "bread" & "butter" | |
| $esc.xml($xml) -> &quot;bread&quot; &amp; &quot;butter&quot; | |
| $sql -> McHale's Navy | |
| $esc.sql($sql) -> McHale''s Navy | |
| $url -> hello here & there | |
| $esc.url -> hello+here+%26+there | |
| $esc.dollar -> $ | |
| $esc.d -> $ | |
| $esc.hash -> # | |
| $esc.h -> # | |
| $esc.backslash -> \ | |
| $esc.b -> \ | |
| $esc.quote -> " | |
| $esc.q -> " | |
| $esc.singleQuote -> ' | |
| $esc.s -> ' | |
| $esc.newline -> | |
| $esc.n -> | |
| $esc.exclamation -> ! | |
| $esc.e -> ! | |
| Example tools.xml config (if you want to use this with VelocityView): | |
| <tools> | |
| <toolbox scope="application"> | |
| <tool class="org.apache.velocity.tools.generic.EscapeTool"/> | |
| </toolbox> | |
| </tools> | |
| </pre></p> | |
| <p>This tool is entirely threadsafe, and has no instance members. | |
| It may be used in any scope (request, session, or application). | |
| </p> | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Since:</B></DT> | |
| <DD>VelocityTools 1.2</DD> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Id: $</DD> | |
| <DT><B>Author:</B></DT> | |
| <DD><a href="mailto:shinobu@ieee.org">Shinobu Kawai</a></DD> | |
| <DT><B>See Also:</B><DD><CODE>StringEscapeUtils</CODE></DL> | |
| <HR> | |
| <P> | |
| <!-- =========== FIELD SUMMARY =========== --> | |
| <A NAME="field_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Field Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#DEFAULT_KEY">DEFAULT_KEY</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#key">key</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="fields_inherited_from_class_org.apache.velocity.tools.generic.SafeConfig"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#LOCK_CONFIG_KEY">LOCK_CONFIG_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#OLD_LOCK_CONFIG_KEY">OLD_LOCK_CONFIG_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#SAFE_MODE_KEY">SAFE_MODE_KEY</A></CODE></TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> | |
| <A NAME="constructor_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Constructor Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#EscapeTool()">EscapeTool</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <!-- ========== METHOD SUMMARY =========== --> | |
| <A NAME="method_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Method Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#configure(org.apache.velocity.tools.generic.ValueParser)">configure</A></B>(<A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A> values)</CODE> | |
| <BR> | |
| Does the actual configuration.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#dumpString(java.lang.String, boolean)">dumpString</A></B>(java.lang.String string, | |
| boolean key)</CODE> | |
| <BR> | |
| This code was pulled from the Apache Harmony project.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getB()">getB</A></B>()</CODE> | |
| <BR> | |
| Renders a backslash (\).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getBackslash()">getBackslash</A></B>()</CODE> | |
| <BR> | |
| Renders a backslash (\).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getD()">getD</A></B>()</CODE> | |
| <BR> | |
| Renders a dollar sign ($).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getDollar()">getDollar</A></B>()</CODE> | |
| <BR> | |
| Renders a dollar sign ($).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getE()">getE</A></B>()</CODE> | |
| <BR> | |
| Renders an exclamation mark (!).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getExclamation()">getExclamation</A></B>()</CODE> | |
| <BR> | |
| Renders an exclamation mark (!).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getH()">getH</A></B>()</CODE> | |
| <BR> | |
| Renders a hash (#).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getHash()">getHash</A></B>()</CODE> | |
| <BR> | |
| Renders a hash (#).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getKey()">getKey</A></B>()</CODE> | |
| <BR> | |
| Should return the key under which this tool has been configured.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getN()">getN</A></B>()</CODE> | |
| <BR> | |
| Renders a new line character appropriate for the | |
| operating system ("\n" in java).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getNewline()">getNewline</A></B>()</CODE> | |
| <BR> | |
| Renders a new line character appropriate for the | |
| operating system ("\n" in java).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getQ()">getQ</A></B>()</CODE> | |
| <BR> | |
| Renders a double quotation mark (").</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getQuote()">getQuote</A></B>()</CODE> | |
| <BR> | |
| Renders a double quotation mark (").</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getS()">getS</A></B>()</CODE> | |
| <BR> | |
| Renders a single quotation mark (').</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getSingleQuote()">getSingleQuote</A></B>()</CODE> | |
| <BR> | |
| Renders a single quotation mark (').</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#html(java.lang.Object)">html</A></B>(java.lang.Object string)</CODE> | |
| <BR> | |
| Escapes the characters in a <code>String</code> using HTML entities.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#java(java.lang.Object)">java</A></B>(java.lang.Object string)</CODE> | |
| <BR> | |
| Escapes the characters in a <code>String</code> using Java String rules.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#javascript(java.lang.Object)">javascript</A></B>(java.lang.Object string)</CODE> | |
| <BR> | |
| Escapes the characters in a <code>String</code> using JavaScript String rules.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#propertyKey(java.lang.Object)">propertyKey</A></B>(java.lang.Object string)</CODE> | |
| <BR> | |
| Escapes the characters in a <code>String</code> using java.util.Properties rules for escaping property keys.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#propertyValue(java.lang.Object)">propertyValue</A></B>(java.lang.Object string)</CODE> | |
| <BR> | |
| Escapes the characters in a <code>String</code> using java.util.Properties rules for escaping property values.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#setKey(java.lang.String)">setKey</A></B>(java.lang.String key)</CODE> | |
| <BR> | |
| Sets the key under which this tool has been configured.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#sql(java.lang.Object)">sql</A></B>(java.lang.Object string)</CODE> | |
| <BR> | |
| Escapes the characters in a <code>String</code> to be suitable to pass to an SQL query.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#unicode(java.lang.Object)">unicode</A></B>(java.lang.Object code)</CODE> | |
| <BR> | |
| Converts the specified Unicode code point and/or escape sequence into | |
| the associated Unicode character.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#url(java.lang.Object)">url</A></B>(java.lang.Object string)</CODE> | |
| <BR> | |
| Escape the characters in a <code>String</code> to be suitable to use as an HTTP parameter value.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#velocity(java.lang.Object)">velocity</A></B>(java.lang.Object obj)</CODE> | |
| <BR> | |
| Escapes the characters in a <code>String</code> using "poor man's | |
| escaping" for Velocity templates by replacing all '$' characters | |
| with '${esc.d}' and all '#' characters with '${esc.h}'.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#xml(java.lang.Object)">xml</A></B>(java.lang.Object string)</CODE> | |
| <BR> | |
| Escapes the characters in a <code>String</code> using XML entities.</TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_org.apache.velocity.tools.generic.SafeConfig"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#configure(java.util.Map)">configure</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isConfigLocked()">isConfigLocked</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isSafeMode()">isSafeMode</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setLockConfig(boolean)">setLockConfig</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setSafeMode(boolean)">setSafeMode</A></CODE></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <!-- ============ FIELD DETAIL =========== --> | |
| <A NAME="field_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Field Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="DEFAULT_KEY"><!-- --></A><H3> | |
| DEFAULT_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>DEFAULT_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.EscapeTool.DEFAULT_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="key"><!-- --></A><H3> | |
| key</H3> | |
| <PRE> | |
| private java.lang.String <B>key</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> | |
| <A NAME="constructor_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Constructor Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="EscapeTool()"><!-- --></A><H3> | |
| EscapeTool</H3> | |
| <PRE> | |
| public <B>EscapeTool</B>()</PRE> | |
| <DL> | |
| </DL> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <A NAME="method_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Method Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="configure(org.apache.velocity.tools.generic.ValueParser)"><!-- --></A><H3> | |
| configure</H3> | |
| <PRE> | |
| protected void <B>configure</B>(<A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A> values)</PRE> | |
| <DL> | |
| <DD>Does the actual configuration. This is protected, so | |
| subclasses may share the same ValueParser and call configure | |
| at any time, while preventing templates from doing so when | |
| configure(Map) is locked. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#configure(org.apache.velocity.tools.generic.ValueParser)">configure</A></CODE> in class <CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setKey(java.lang.String)"><!-- --></A><H3> | |
| setKey</H3> | |
| <PRE> | |
| protected void <B>setKey</B>(java.lang.String key)</PRE> | |
| <DL> | |
| <DD>Sets the key under which this tool has been configured. | |
| <P> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#velocity(java.lang.Object)"><CODE>velocity(java.lang.Object)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getKey()"><!-- --></A><H3> | |
| getKey</H3> | |
| <PRE> | |
| public java.lang.String <B>getKey</B>()</PRE> | |
| <DL> | |
| <DD>Should return the key under which this tool has been configured. | |
| The default is 'esc'. | |
| <P> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#velocity(java.lang.Object)"><CODE>velocity(java.lang.Object)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="velocity(java.lang.Object)"><!-- --></A><H3> | |
| velocity</H3> | |
| <PRE> | |
| public java.lang.String <B>velocity</B>(java.lang.Object obj)</PRE> | |
| <DL> | |
| <DD><p>Escapes the characters in a <code>String</code> using "poor man's | |
| escaping" for Velocity templates by replacing all '$' characters | |
| with '${esc.d}' and all '#' characters with '${esc.h}'. This form | |
| of escaping is far more reliable and consistent than using '\' to | |
| escape valid references, directives and macros, though it does require | |
| that you have the EscapeTool available in the context when you later | |
| go to process the result returned by this method. | |
| </p><p> | |
| <b>NOTE</b>: This will only work so long as the EscapeTool is placed | |
| in the context using its default key 'esc' <i>or</i> you are using | |
| VelocityTools 2.0+ and have put this tool in one of your toolboxes | |
| under an alternate key (in which case the EscapeTool will automatically | |
| be told what its new key is). If for some strange reason you wish | |
| to use an alternate key and are not using the tool management facilities | |
| of VelocityTools 2.0+, you must subclass this tool and manually call | |
| setKey(String) before using this method. | |
| </p> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the string value that needs escaping | |
| <DT><B>Returns:</B><DD>String with escaped values, <code>null</code> if null string input</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="java(java.lang.Object)"><!-- --></A><H3> | |
| java</H3> | |
| <PRE> | |
| public java.lang.String <B>java</B>(java.lang.Object string)</PRE> | |
| <DL> | |
| <DD>Escapes the characters in a <code>String</code> using Java String rules. | |
| <br /> | |
| Delegates the process to <CODE>StringEscapeUtils.escapeJava(String)</CODE>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>string</CODE> - the string to escape values, may be null | |
| <DT><B>Returns:</B><DD>String with escaped values, <code>null</code> if null string input<DT><B>See Also:</B><DD><CODE>StringEscapeUtils.escapeJava(String)</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="propertyKey(java.lang.Object)"><!-- --></A><H3> | |
| propertyKey</H3> | |
| <PRE> | |
| public java.lang.String <B>propertyKey</B>(java.lang.Object string)</PRE> | |
| <DL> | |
| <DD>Escapes the characters in a <code>String</code> using java.util.Properties rules for escaping property keys. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>string</CODE> - the string to escape values, may be null | |
| <DT><B>Returns:</B><DD>String with escaped values, <code>null</code> if null string input<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#dumpString(java.lang.String, boolean)"><CODE>dumpString(String, boolean)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="propertyValue(java.lang.Object)"><!-- --></A><H3> | |
| propertyValue</H3> | |
| <PRE> | |
| public java.lang.String <B>propertyValue</B>(java.lang.Object string)</PRE> | |
| <DL> | |
| <DD>Escapes the characters in a <code>String</code> using java.util.Properties rules for escaping property values. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>string</CODE> - the string to escape values, may be null | |
| <DT><B>Returns:</B><DD>String with escaped values, <code>null</code> if null string input<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#dumpString(java.lang.String, boolean)"><CODE>dumpString(String, boolean)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="dumpString(java.lang.String, boolean)"><!-- --></A><H3> | |
| dumpString</H3> | |
| <PRE> | |
| protected java.lang.String <B>dumpString</B>(java.lang.String string, | |
| boolean key)</PRE> | |
| <DL> | |
| <DD>This code was pulled from the Apache Harmony project. See | |
| https://svn.apache.org/repos/asf/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/util/Properties.java | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="javascript(java.lang.Object)"><!-- --></A><H3> | |
| javascript</H3> | |
| <PRE> | |
| public java.lang.String <B>javascript</B>(java.lang.Object string)</PRE> | |
| <DL> | |
| <DD>Escapes the characters in a <code>String</code> using JavaScript String rules. | |
| <br /> | |
| Delegates the process to <CODE>StringEscapeUtils.escapeJavaScript(String)</CODE>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>string</CODE> - the string to escape values, may be null | |
| <DT><B>Returns:</B><DD>String with escaped values, <code>null</code> if null string input<DT><B>See Also:</B><DD><CODE>StringEscapeUtils.escapeJavaScript(String)</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="html(java.lang.Object)"><!-- --></A><H3> | |
| html</H3> | |
| <PRE> | |
| public java.lang.String <B>html</B>(java.lang.Object string)</PRE> | |
| <DL> | |
| <DD>Escapes the characters in a <code>String</code> using HTML entities. | |
| <br /> | |
| Delegates the process to <CODE>StringEscapeUtils.escapeHtml(String)</CODE>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>string</CODE> - the string to escape, may be null | |
| <DT><B>Returns:</B><DD>a new escaped <code>String</code>, <code>null</code> if null string input<DT><B>See Also:</B><DD><CODE>StringEscapeUtils.escapeHtml(String)</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="url(java.lang.Object)"><!-- --></A><H3> | |
| url</H3> | |
| <PRE> | |
| public java.lang.String <B>url</B>(java.lang.Object string)</PRE> | |
| <DL> | |
| <DD>Escape the characters in a <code>String</code> to be suitable to use as an HTTP parameter value. | |
| <br/> | |
| Uses UTF-8 as default character encoding. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>string</CODE> - the string to escape, may be null | |
| <DT><B>Returns:</B><DD>a new escaped <code>String</code>, <code>null</code> if null string input | |
| See java.net.URLEncoder#encode(String,String).<DT><B>Since:</B></DT> | |
| <DD>VelocityTools 1.3</DD> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="xml(java.lang.Object)"><!-- --></A><H3> | |
| xml</H3> | |
| <PRE> | |
| public java.lang.String <B>xml</B>(java.lang.Object string)</PRE> | |
| <DL> | |
| <DD>Escapes the characters in a <code>String</code> using XML entities. | |
| <br /> | |
| Delegates the process to <CODE>StringEscapeUtils.escapeXml(String)</CODE>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>string</CODE> - the string to escape, may be null | |
| <DT><B>Returns:</B><DD>a new escaped <code>String</code>, <code>null</code> if null string input<DT><B>See Also:</B><DD><CODE>StringEscapeUtils.escapeXml(String)</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="sql(java.lang.Object)"><!-- --></A><H3> | |
| sql</H3> | |
| <PRE> | |
| public java.lang.String <B>sql</B>(java.lang.Object string)</PRE> | |
| <DL> | |
| <DD>Escapes the characters in a <code>String</code> to be suitable to pass to an SQL query. | |
| <br /> | |
| Delegates the process to <CODE>StringEscapeUtils.escapeSql(String)</CODE>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>string</CODE> - the string to escape, may be null | |
| <DT><B>Returns:</B><DD>a new String, escaped for SQL, <code>null</code> if null string input<DT><B>See Also:</B><DD><CODE>StringEscapeUtils.escapeSql(String)</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="unicode(java.lang.Object)"><!-- --></A><H3> | |
| unicode</H3> | |
| <PRE> | |
| public java.lang.String <B>unicode</B>(java.lang.Object code)</PRE> | |
| <DL> | |
| <DD>Converts the specified Unicode code point and/or escape sequence into | |
| the associated Unicode character. This allows numeric | |
| code points or String versions of the numeric code point to be correctly | |
| translated within a template. This is especially useful for those | |
| creating unicode from a reference value, or injecting a unicode character | |
| into a template with a version of Velocity prior to 1.6. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>code</CODE> - the code to be translated/escaped, may be null | |
| <DT><B>Returns:</B><DD>the unicode character for that code, <code>null</code> if input was null<DT><B>See Also:</B><DD><CODE>Character.toChars(int codePoint)</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDollar()"><!-- --></A><H3> | |
| getDollar</H3> | |
| <PRE> | |
| public java.lang.String <B>getDollar</B>()</PRE> | |
| <DL> | |
| <DD>Renders a dollar sign ($). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>a dollar sign ($).<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getD()"><CODE>getD()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getD()"><!-- --></A><H3> | |
| getD</H3> | |
| <PRE> | |
| public java.lang.String <B>getD</B>()</PRE> | |
| <DL> | |
| <DD>Renders a dollar sign ($). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>a dollar sign ($).<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getDollar()"><CODE>getDollar()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getHash()"><!-- --></A><H3> | |
| getHash</H3> | |
| <PRE> | |
| public java.lang.String <B>getHash</B>()</PRE> | |
| <DL> | |
| <DD>Renders a hash (#). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>a hash (#).<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getH()"><CODE>getH()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getH()"><!-- --></A><H3> | |
| getH</H3> | |
| <PRE> | |
| public java.lang.String <B>getH</B>()</PRE> | |
| <DL> | |
| <DD>Renders a hash (#). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>a hash (#).<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getHash()"><CODE>getHash()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getBackslash()"><!-- --></A><H3> | |
| getBackslash</H3> | |
| <PRE> | |
| public java.lang.String <B>getBackslash</B>()</PRE> | |
| <DL> | |
| <DD>Renders a backslash (\). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>a backslash (\).<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getB()"><CODE>getB()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getB()"><!-- --></A><H3> | |
| getB</H3> | |
| <PRE> | |
| public java.lang.String <B>getB</B>()</PRE> | |
| <DL> | |
| <DD>Renders a backslash (\). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>a backslash (\).<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getBackslash()"><CODE>getBackslash()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getQuote()"><!-- --></A><H3> | |
| getQuote</H3> | |
| <PRE> | |
| public java.lang.String <B>getQuote</B>()</PRE> | |
| <DL> | |
| <DD>Renders a double quotation mark ("). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>a double quotation mark (").<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getQ()"><CODE>getQ()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getQ()"><!-- --></A><H3> | |
| getQ</H3> | |
| <PRE> | |
| public java.lang.String <B>getQ</B>()</PRE> | |
| <DL> | |
| <DD>Renders a double quotation mark ("). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>a double quotation mark (").<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getQuote()"><CODE>getQuote()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getSingleQuote()"><!-- --></A><H3> | |
| getSingleQuote</H3> | |
| <PRE> | |
| public java.lang.String <B>getSingleQuote</B>()</PRE> | |
| <DL> | |
| <DD>Renders a single quotation mark ('). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>a single quotation mark (').<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getS()"><CODE>getS()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getS()"><!-- --></A><H3> | |
| getS</H3> | |
| <PRE> | |
| public java.lang.String <B>getS</B>()</PRE> | |
| <DL> | |
| <DD>Renders a single quotation mark ('). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>a single quotation mark (').<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getSingleQuote()"><CODE>getSingleQuote()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNewline()"><!-- --></A><H3> | |
| getNewline</H3> | |
| <PRE> | |
| public java.lang.String <B>getNewline</B>()</PRE> | |
| <DL> | |
| <DD>Renders a new line character appropriate for the | |
| operating system ("\n" in java). | |
| <P> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getN()"><CODE>getN()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getN()"><!-- --></A><H3> | |
| getN</H3> | |
| <PRE> | |
| public java.lang.String <B>getN</B>()</PRE> | |
| <DL> | |
| <DD>Renders a new line character appropriate for the | |
| operating system ("\n" in java). | |
| <P> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getNewline()"><CODE>getNewline()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getExclamation()"><!-- --></A><H3> | |
| getExclamation</H3> | |
| <PRE> | |
| public java.lang.String <B>getExclamation</B>()</PRE> | |
| <DL> | |
| <DD>Renders an exclamation mark (!). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>an exclamation mark (!).<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getE()"><CODE>getE()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getE()"><!-- --></A><H3> | |
| getE</H3> | |
| <PRE> | |
| public java.lang.String <B>getE</B>()</PRE> | |
| <DL> | |
| <DD>Renders an exclamation mark (!). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>an exclamation mark (!).<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html#getExclamation()"><CODE>getExclamation()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <HR> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <A NAME="navbar_bottom"><!-- --></A> | |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.Measurements.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/generic/FieldTool.html" title="class in org.apache.velocity.tools.generic"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/EscapeTool.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="EscapeTool.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_bottom"></A> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <HR> | |
| Copyright (c) 2003-2007 Apache Software Foundation | |
| </BODY> | |
| </HTML> |