You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@velocity.apache.org by nb...@apache.org on 2006/12/22 06:44:18 UTC
svn commit: r489560 [6/15] - in /velocity/tools/trunk/docs: ./ generic/
javadoc/ javadoc/org/apache/velocity/tools/generic/
javadoc/org/apache/velocity/tools/generic/log/
javadoc/org/apache/velocity/tools/struts/
javadoc/org/apache/velocity/tools/view/...
Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/EscapeTool.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/EscapeTool.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/EscapeTool.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/EscapeTool.html Thu Dec 21 21:44:15 2006
@@ -1,675 +1,675 @@
-<!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_09) on Tue Nov 21 22:45:25 CET 2006 -->
-<TITLE>
-EscapeTool (Velocity Tools 1.3-dev 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 (Velocity Tools 1.3-dev 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/DateTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
- <A HREF="../../../../../org/apache/velocity/tools/generic/IteratorTool.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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: FIELD | <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 "><B>org.apache.velocity.tools.generic.EscapeTool</B>
-</PRE>
-<HR>
-<DL>
-<DT><PRE>public class <B>EscapeTool</B><DT>extends java.lang.Object</DL>
-</PRE>
-
-<P>
-Tool for working with escaping in Velocity templates.
- It provides methods to escape outputs for Java, JavaScript, HTML, XML and SQL.
- Also provides methods to render VTL characters that otherwise needs escaping.
-
- <p><pre>
- Example uses:
- $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
-
- $esc.dollar -> $
- $esc.d -> $
-
- $esc.hash -> #
- $esc.h -> #
-
- $esc.backslash -> \
- $esc.b -> \
-
- $esc.quote -> "
- $esc.q -> "
-
- $esc.singleQuote -> '
- $esc.s -> '
-
- $esc.exclamation -> !
- $esc.e -> !
-
- Example toolbox.xml config (if you want to use this with VelocityView):
- <tool>
- <key>esc</key>
- <scope>application</scope>
- <class>org.apache.velocity.tools.generic.EscapeTool</class>
- </tool>
- </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>
-
-<!-- ======== 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>
- Default constructor.</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> 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#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#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#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_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>
-
-<!-- ========= 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>
-<DD>Default constructor.
-<P>
-</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="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="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="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="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="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/DateTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
- <A HREF="../../../../../org/apache/velocity/tools/generic/IteratorTool.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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: FIELD | <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-2006 Apache Software Foundation
-</BODY>
-</HTML>
+<!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_02) on Thu Dec 21 21:15:29 PST 2006 -->
+<TITLE>
+EscapeTool (VelocityTools 1.3-beta1 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 1.3-beta1 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/DateTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/velocity/tools/generic/IteratorTool.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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <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 "><B>org.apache.velocity.tools.generic.EscapeTool</B>
+</PRE>
+<HR>
+<DL>
+<DT><PRE>public class <B>EscapeTool</B><DT>extends java.lang.Object</DL>
+</PRE>
+
+<P>
+Tool for working with escaping in Velocity templates.
+ It provides methods to escape outputs for Java, JavaScript, HTML, XML and SQL.
+ Also provides methods to render VTL characters that otherwise needs escaping.
+
+ <p><pre>
+ Example uses:
+ $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
+
+ $esc.dollar -> $
+ $esc.d -> $
+
+ $esc.hash -> #
+ $esc.h -> #
+
+ $esc.backslash -> \
+ $esc.b -> \
+
+ $esc.quote -> "
+ $esc.q -> "
+
+ $esc.singleQuote -> '
+ $esc.s -> '
+
+ $esc.exclamation -> !
+ $esc.e -> !
+
+ Example toolbox.xml config (if you want to use this with VelocityView):
+ <tool>
+ <key>esc</key>
+ <scope>application</scope>
+ <class>org.apache.velocity.tools.generic.EscapeTool</class>
+ </tool>
+ </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>
+
+<!-- ======== 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>
+ Default constructor.</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> 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#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#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#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_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>
+
+<!-- ========= 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>
+<DD>Default constructor.
+<P>
+</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="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="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="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="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="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/DateTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/velocity/tools/generic/IteratorTool.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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <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-2006 Apache Software Foundation
+</BODY>
+</HTML>
Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/IteratorTool.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/IteratorTool.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/IteratorTool.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/IteratorTool.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:25 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:30 PST 2006 -->
<TITLE>
-IteratorTool (Velocity Tools 1.3-dev Documentation)
+IteratorTool (VelocityTools 1.3-beta1 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.IteratorTool class">
@@ -14,7 +14,7 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="IteratorTool (Velocity Tools 1.3-dev Documentation)";
+ parent.document.title="IteratorTool (VelocityTools 1.3-beta1 Documentation)";
}
</SCRIPT>
<NOSCRIPT>