| <!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> | |
| ConversionTool (VelocityTools 2.0 Documentation) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.ConversionTool class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="ConversionTool (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/ContextTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.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/ConversionTool.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ConversionTool.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 ConversionTool</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 "><A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.LocaleConfig</A> | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.ConversionTool</B> | |
| </PRE> | |
| <DL> | |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A></DD> | |
| </DL> | |
| <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>="convert") | |
| <A HREF="../../../../../org/apache/velocity/tools/config/SkipSetters.html" title="annotation in org.apache.velocity.tools.config">@SkipSetters</A> | |
| </FONT>public class <B>ConversionTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html" title="class in org.apache.velocity.tools.generic">LocaleConfig</A></DL> | |
| </PRE> | |
| <P> | |
| <p>Utility class for easy conversion of String values to richer types.</p> | |
| <p><pre> | |
| Template example(s): | |
| $convert.toNumber('12.6') -> 12.6 | |
| $convert.toInt('12.6') -> 12 | |
| $convert.toNumbers('12.6,42') -> [12.6, 42] | |
| Toolbox configuration: | |
| <tools> | |
| <toolbox scope="application"> | |
| <tool class="org.apache.velocity.tools.generic.ConversionTool" | |
| dateFormat="yyyy-MM-dd"/> | |
| </toolbox> | |
| </tools> | |
| </pre></p> | |
| <p>This comes in very handy when parsing anything.</p> | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Since:</B></DT> | |
| <DD>VelocityTools 2.0</DD> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Revision: 932578 $ $Date: 2007-02-26 11:24:39 -0800 (Mon, 26 Feb 2007) $</DD> | |
| <DT><B>Author:</B></DT> | |
| <DD>Nathan Bubna</DD> | |
| </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/ConversionTool.html#DATE_FORMAT_KEY">DATE_FORMAT_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/ConversionTool.html#dateFormat">dateFormat</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </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/ConversionTool.html#DEFAULT_DATE_FORMAT">DEFAULT_DATE_FORMAT</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </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/ConversionTool.html#DEFAULT_NUMBER_FORMAT">DEFAULT_NUMBER_FORMAT</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </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/ConversionTool.html#DEFAULT_STRINGS_DELIMITER">DEFAULT_STRINGS_DELIMITER</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#DEFAULT_STRINGS_TRIM">DEFAULT_STRINGS_TRIM</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </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/ConversionTool.html#NUMBER_FORMAT_KEY">NUMBER_FORMAT_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/ConversionTool.html#numberFormat">numberFormat</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </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/ConversionTool.html#STRINGS_DELIMITER_FORMAT_KEY">STRINGS_DELIMITER_FORMAT_KEY</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </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/ConversionTool.html#STRINGS_TRIM_KEY">STRINGS_TRIM_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/ConversionTool.html#stringsDelimiter">stringsDelimiter</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#stringsTrim">stringsTrim</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="fields_inherited_from_class_org.apache.velocity.tools.generic.LocaleConfig"><!-- --></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/LocaleConfig.html" title="class in org.apache.velocity.tools.generic">LocaleConfig</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html#DEFAULT_LOCALE">DEFAULT_LOCALE</A></CODE></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/ConversionTool.html#ConversionTool()">ConversionTool</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/ConversionTool.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> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#getDateFormat()">getDateFormat</A></B>()</CODE> | |
| <BR> | |
| </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/ConversionTool.html#getNumberFormat()">getNumberFormat</A></B>()</CODE> | |
| <BR> | |
| </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/ConversionTool.html#getStringsDelimiter()">getStringsDelimiter</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#getStringsTrim()">getStringsTrim</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.lang.Boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseBoolean(java.lang.String)">parseBoolean</A></B>(java.lang.String value)</CODE> | |
| <BR> | |
| Converts a parameter value into a <CODE>Boolean</CODE> | |
| Sub-classes can override to allow for customized boolean parsing.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Date</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseDate(java.lang.String)">parseDate</A></B>(java.lang.String value)</CODE> | |
| <BR> | |
| Converts a string to an instance of <CODE>Date</CODE>, | |
| using the configured date parsing format, the configured default | |
| <CODE>Locale</CODE>, and the system's default <CODE>TimeZone</CODE> to parse it.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Date</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseDate(java.lang.String, java.lang.Object)">parseDate</A></B>(java.lang.String value, | |
| java.lang.Object locale)</CODE> | |
| <BR> | |
| Converts a string to an instance of <CODE>Date</CODE> using the | |
| configured date format and specified <CODE>Locale</CODE> to parse it.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Date</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseDate(java.lang.String, java.lang.String)">parseDate</A></B>(java.lang.String value, | |
| java.lang.String format)</CODE> | |
| <BR> | |
| Converts a string to an instance of <CODE>Date</CODE> using the | |
| specified format,the configured default <CODE>Locale</CODE>, | |
| and the system's default <CODE>TimeZone</CODE> to parse it.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Date</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseDate(java.lang.String, java.lang.String, java.lang.Object)">parseDate</A></B>(java.lang.String value, | |
| java.lang.String format, | |
| java.lang.Object locale)</CODE> | |
| <BR> | |
| Converts a string to an instance of <CODE>Date</CODE> using the | |
| specified format and <CODE>Locale</CODE> to parse it.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Date</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseDate(java.lang.String, java.lang.String, java.lang.Object, java.util.TimeZone)">parseDate</A></B>(java.lang.String value, | |
| java.lang.String format, | |
| java.lang.Object locale, | |
| java.util.TimeZone timezone)</CODE> | |
| <BR> | |
| Converts a string to an instance of <CODE>Date</CODE> using the | |
| specified format, <CODE>Locale</CODE>, and <CODE>TimeZone</CODE>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.util.Locale</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseLocale(java.lang.String)">parseLocale</A></B>(java.lang.String value)</CODE> | |
| <BR> | |
| Converts a String value into a Locale.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Number</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseNumber(java.lang.String)">parseNumber</A></B>(java.lang.String value)</CODE> | |
| <BR> | |
| Converts an object to an instance of <CODE>Number</CODE> using the | |
| format returned by <A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#getNumberFormat()"><CODE>getNumberFormat()</CODE></A> and the default <CODE>Locale</CODE> | |
| if the object is not already an instance of Number.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Number</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseNumber(java.lang.String, java.lang.Object)">parseNumber</A></B>(java.lang.String value, | |
| java.lang.Object locale)</CODE> | |
| <BR> | |
| Converts an object to an instance of <CODE>Number</CODE> using the | |
| configured number format and the specified <CODE>Locale</CODE>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Number</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseNumber(java.lang.String, java.lang.String)">parseNumber</A></B>(java.lang.String value, | |
| java.lang.String format)</CODE> | |
| <BR> | |
| Converts an object to an instance of <CODE>Number</CODE> using the | |
| specified format and the <CODE>Locale</CODE> returned by | |
| <A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html#getLocale()"><CODE>LocaleConfig.getLocale()</CODE></A>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Number</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseNumber(java.lang.String, java.lang.String, java.lang.Object)">parseNumber</A></B>(java.lang.String value, | |
| java.lang.String format, | |
| java.lang.Object locale)</CODE> | |
| <BR> | |
| Converts an object to an instance of <CODE>Number</CODE> using the | |
| specified format and <CODE>Locale</CODE>.</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/ConversionTool.html#parseStringList(java.lang.String)">parseStringList</A></B>(java.lang.String value)</CODE> | |
| <BR> | |
| Converts a single String value into an array of Strings by splitting | |
| it on the tool's set stringsDelimiter.</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/ConversionTool.html#setDateFormat(java.lang.String)">setDateFormat</A></B>(java.lang.String format)</CODE> | |
| <BR> | |
| </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/ConversionTool.html#setNumberFormat(java.lang.String)">setNumberFormat</A></B>(java.lang.String format)</CODE> | |
| <BR> | |
| </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/ConversionTool.html#setStringsDelimiter(java.lang.String)">setStringsDelimiter</A></B>(java.lang.String stringsDelimiter)</CODE> | |
| <BR> | |
| Sets the delimiter used for separating values in a single String value.</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/ConversionTool.html#setStringsTrim(boolean)">setStringsTrim</A></B>(boolean stringsTrim)</CODE> | |
| <BR> | |
| Sets whether strings should be trimmed when separated from | |
| a delimited string value.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toBoolean(java.lang.Object)">toBoolean</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Boolean[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toBooleans(java.util.Collection)">toBooleans</A></B>(java.util.Collection values)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Boolean[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toBooleans(java.lang.Object)">toBooleans</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Calendar</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toCalendar(java.lang.Object)">toCalendar</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Calendar[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toCalendars(java.util.Collection)">toCalendars</A></B>(java.util.Collection values)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Calendar[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toCalendars(java.lang.Object)">toCalendars</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Date</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toDate(java.lang.Object)">toDate</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| Converts an object to an instance of <CODE>Date</CODE>, when necessary | |
| using the configured date parsing format, the configured default | |
| <CODE>Locale</CODE>, and the system's default <CODE>TimeZone</CODE> to parse | |
| the string value of the specified object.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Date[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toDates(java.util.Collection)">toDates</A></B>(java.util.Collection values)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Date[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toDates(java.lang.Object)">toDates</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Double</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toDouble(java.lang.Object)">toDouble</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> double[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toDoubles(java.lang.Object)">toDoubles</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Integer</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toInteger(java.lang.Object)">toInteger</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toIntegers(java.lang.Object)">toIntegers</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toInts(java.lang.Object)">toInts</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Locale</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toLocale(java.lang.Object)">toLocale</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Locale[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toLocales(java.util.Collection)">toLocales</A></B>(java.util.Collection values)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Locale[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toLocales(java.lang.Object)">toLocales</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Number</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toNumber(java.lang.Object)">toNumber</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Number[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toNumbers(java.util.Collection)">toNumbers</A></B>(java.util.Collection values)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Number[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#toNumbers(java.lang.Object)">toNumbers</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </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/ConversionTool.html#toString(java.lang.Object)">toString</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| Converts objects to String in a more Tools-ish way than | |
| String.valueOf(Object), especially with nulls, Arrays and Collections.</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/ConversionTool.html#toStrings(java.lang.Object)">toStrings</A></B>(java.lang.Object value)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_org.apache.velocity.tools.generic.LocaleConfig"><!-- --></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/LocaleConfig.html" title="class in org.apache.velocity.tools.generic">LocaleConfig</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html#getLocale()">getLocale</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html#setLocale(java.util.Locale)">setLocale</A></CODE></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="STRINGS_DELIMITER_FORMAT_KEY"><!-- --></A><H3> | |
| STRINGS_DELIMITER_FORMAT_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>STRINGS_DELIMITER_FORMAT_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.ConversionTool.STRINGS_DELIMITER_FORMAT_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="STRINGS_TRIM_KEY"><!-- --></A><H3> | |
| STRINGS_TRIM_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>STRINGS_TRIM_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.ConversionTool.STRINGS_TRIM_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="DATE_FORMAT_KEY"><!-- --></A><H3> | |
| DATE_FORMAT_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>DATE_FORMAT_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.ConversionTool.DATE_FORMAT_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="NUMBER_FORMAT_KEY"><!-- --></A><H3> | |
| NUMBER_FORMAT_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>NUMBER_FORMAT_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.ConversionTool.NUMBER_FORMAT_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="DEFAULT_STRINGS_DELIMITER"><!-- --></A><H3> | |
| DEFAULT_STRINGS_DELIMITER</H3> | |
| <PRE> | |
| public static final java.lang.String <B>DEFAULT_STRINGS_DELIMITER</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.ConversionTool.DEFAULT_STRINGS_DELIMITER">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="DEFAULT_STRINGS_TRIM"><!-- --></A><H3> | |
| DEFAULT_STRINGS_TRIM</H3> | |
| <PRE> | |
| public static final boolean <B>DEFAULT_STRINGS_TRIM</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.ConversionTool.DEFAULT_STRINGS_TRIM">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="DEFAULT_NUMBER_FORMAT"><!-- --></A><H3> | |
| DEFAULT_NUMBER_FORMAT</H3> | |
| <PRE> | |
| public static final java.lang.String <B>DEFAULT_NUMBER_FORMAT</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.ConversionTool.DEFAULT_NUMBER_FORMAT">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="DEFAULT_DATE_FORMAT"><!-- --></A><H3> | |
| DEFAULT_DATE_FORMAT</H3> | |
| <PRE> | |
| public static final java.lang.String <B>DEFAULT_DATE_FORMAT</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.ConversionTool.DEFAULT_DATE_FORMAT">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="stringsDelimiter"><!-- --></A><H3> | |
| stringsDelimiter</H3> | |
| <PRE> | |
| private java.lang.String <B>stringsDelimiter</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="stringsTrim"><!-- --></A><H3> | |
| stringsTrim</H3> | |
| <PRE> | |
| private boolean <B>stringsTrim</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="numberFormat"><!-- --></A><H3> | |
| numberFormat</H3> | |
| <PRE> | |
| private java.lang.String <B>numberFormat</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="dateFormat"><!-- --></A><H3> | |
| dateFormat</H3> | |
| <PRE> | |
| private java.lang.String <B>dateFormat</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="ConversionTool()"><!-- --></A><H3> | |
| ConversionTool</H3> | |
| <PRE> | |
| public <B>ConversionTool</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/LocaleConfig.html#configure(org.apache.velocity.tools.generic.ValueParser)">configure</A></CODE> in class <CODE><A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html" title="class in org.apache.velocity.tools.generic">LocaleConfig</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setStringsDelimiter(java.lang.String)"><!-- --></A><H3> | |
| setStringsDelimiter</H3> | |
| <PRE> | |
| protected final void <B>setStringsDelimiter</B>(java.lang.String stringsDelimiter)</PRE> | |
| <DL> | |
| <DD>Sets the delimiter used for separating values in a single String value. | |
| The default string delimiter is a comma. | |
| <P> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseStringList(java.lang.String)"><CODE>parseStringList(java.lang.String)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getStringsDelimiter()"><!-- --></A><H3> | |
| getStringsDelimiter</H3> | |
| <PRE> | |
| public final java.lang.String <B>getStringsDelimiter</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setStringsTrim(boolean)"><!-- --></A><H3> | |
| setStringsTrim</H3> | |
| <PRE> | |
| protected final void <B>setStringsTrim</B>(boolean stringsTrim)</PRE> | |
| <DL> | |
| <DD>Sets whether strings should be trimmed when separated from | |
| a delimited string value. | |
| The default is true. | |
| <P> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseStringList(java.lang.String)"><CODE>parseStringList(java.lang.String)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getStringsTrim()"><!-- --></A><H3> | |
| getStringsTrim</H3> | |
| <PRE> | |
| public final boolean <B>getStringsTrim</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setNumberFormat(java.lang.String)"><!-- --></A><H3> | |
| setNumberFormat</H3> | |
| <PRE> | |
| protected final void <B>setNumberFormat</B>(java.lang.String format)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNumberFormat()"><!-- --></A><H3> | |
| getNumberFormat</H3> | |
| <PRE> | |
| public final java.lang.String <B>getNumberFormat</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setDateFormat(java.lang.String)"><!-- --></A><H3> | |
| setDateFormat</H3> | |
| <PRE> | |
| protected final void <B>setDateFormat</B>(java.lang.String format)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDateFormat()"><!-- --></A><H3> | |
| getDateFormat</H3> | |
| <PRE> | |
| public final java.lang.String <B>getDateFormat</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toString(java.lang.Object)"><!-- --></A><H3> | |
| toString</H3> | |
| <PRE> | |
| public java.lang.String <B>toString</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD>Converts objects to String in a more Tools-ish way than | |
| String.valueOf(Object), especially with nulls, Arrays and Collections. | |
| Null returns null, Arrays and Collections return the toString(Object) | |
| of their first value, or null if they have no values. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the object to be turned into a String | |
| <DT><B>Returns:</B><DD>the string value of the object or null if the value is null | |
| or it is an array or collection whose first value is null</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toBoolean(java.lang.Object)"><!-- --></A><H3> | |
| toBoolean</H3> | |
| <PRE> | |
| public java.lang.Boolean <B>toBoolean</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the object to be converted | |
| <DT><B>Returns:</B><DD>a <CODE>Boolean</CODE> object for the specified value or | |
| <code>null</code> if the value is null or the conversion failed</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toInteger(java.lang.Object)"><!-- --></A><H3> | |
| toInteger</H3> | |
| <PRE> | |
| public java.lang.Integer <B>toInteger</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the object to be converted | |
| <DT><B>Returns:</B><DD>a <CODE>Integer</CODE> for the specified value or | |
| <code>null</code> if the value is null or the conversion failed</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toDouble(java.lang.Object)"><!-- --></A><H3> | |
| toDouble</H3> | |
| <PRE> | |
| public java.lang.Double <B>toDouble</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the object to be converted | |
| <DT><B>Returns:</B><DD>a <CODE>Double</CODE> for the specified value or | |
| <code>null</code> if the value is null or the conversion failed</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toNumber(java.lang.Object)"><!-- --></A><H3> | |
| toNumber</H3> | |
| <PRE> | |
| public java.lang.Number <B>toNumber</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the object to be converted | |
| <DT><B>Returns:</B><DD>a <CODE>Number</CODE> for the specified value or | |
| <code>null</code> if the value is null or the conversion failed</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toLocale(java.lang.Object)"><!-- --></A><H3> | |
| toLocale</H3> | |
| <PRE> | |
| public java.util.Locale <B>toLocale</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the object to be converted | |
| <DT><B>Returns:</B><DD>a <CODE>Locale</CODE> for the specified value or | |
| <code>null</code> if the value is null or the conversion failed</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toDate(java.lang.Object)"><!-- --></A><H3> | |
| toDate</H3> | |
| <PRE> | |
| public java.util.Date <B>toDate</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD>Converts an object to an instance of <CODE>Date</CODE>, when necessary | |
| using the configured date parsing format, the configured default | |
| <CODE>Locale</CODE>, and the system's default <CODE>TimeZone</CODE> to parse | |
| the string value of the specified object. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the date to convert | |
| <DT><B>Returns:</B><DD>the object as a <CODE>Date</CODE> or <code>null</code> if no | |
| conversion is possible</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toCalendar(java.lang.Object)"><!-- --></A><H3> | |
| toCalendar</H3> | |
| <PRE> | |
| public java.util.Calendar <B>toCalendar</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toStrings(java.lang.Object)"><!-- --></A><H3> | |
| toStrings</H3> | |
| <PRE> | |
| public java.lang.String[] <B>toStrings</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be converted | |
| <DT><B>Returns:</B><DD>an array of String objects containing all of the values | |
| derived from the specified array, Collection, or delimited String</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toBooleans(java.lang.Object)"><!-- --></A><H3> | |
| toBooleans</H3> | |
| <PRE> | |
| public java.lang.Boolean[] <B>toBooleans</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be converted | |
| <DT><B>Returns:</B><DD>an array of Boolean objects derived from the specified value, | |
| or <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toBooleans(java.util.Collection)"><!-- --></A><H3> | |
| toBooleans</H3> | |
| <PRE> | |
| public java.lang.Boolean[] <B>toBooleans</B>(java.util.Collection values)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>values</CODE> - the collection of values to be converted | |
| <DT><B>Returns:</B><DD>an array of Boolean objects derived from the specified values, | |
| or <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toNumbers(java.lang.Object)"><!-- --></A><H3> | |
| toNumbers</H3> | |
| <PRE> | |
| public java.lang.Number[] <B>toNumbers</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be converted | |
| <DT><B>Returns:</B><DD>an array of Number objects derived from the specified value, | |
| or <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toNumbers(java.util.Collection)"><!-- --></A><H3> | |
| toNumbers</H3> | |
| <PRE> | |
| public java.lang.Number[] <B>toNumbers</B>(java.util.Collection values)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>values</CODE> - the collection of values to be converted | |
| <DT><B>Returns:</B><DD>an array of Number objects derived from the specified values, | |
| or <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toInts(java.lang.Object)"><!-- --></A><H3> | |
| toInts</H3> | |
| <PRE> | |
| public int[] <B>toInts</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be converted | |
| <DT><B>Returns:</B><DD>an array of int values derived from the specified value, | |
| or <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toIntegers(java.lang.Object)"><!-- --></A><H3> | |
| toIntegers</H3> | |
| <PRE> | |
| public int[] <B>toIntegers</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be converted | |
| <DT><B>Returns:</B><DD>an array of int values derived from the specified value, | |
| or <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toDoubles(java.lang.Object)"><!-- --></A><H3> | |
| toDoubles</H3> | |
| <PRE> | |
| public double[] <B>toDoubles</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be converted | |
| <DT><B>Returns:</B><DD>an array of double values derived from the specified value, | |
| or <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toLocales(java.lang.Object)"><!-- --></A><H3> | |
| toLocales</H3> | |
| <PRE> | |
| public java.util.Locale[] <B>toLocales</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be converted | |
| <DT><B>Returns:</B><DD>an array of Locale objects derived from the specified value, | |
| or <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toLocales(java.util.Collection)"><!-- --></A><H3> | |
| toLocales</H3> | |
| <PRE> | |
| public java.util.Locale[] <B>toLocales</B>(java.util.Collection values)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>values</CODE> - the collection of values to be converted | |
| <DT><B>Returns:</B><DD>an array of Locale objects derived from the specified values, | |
| or <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toDates(java.lang.Object)"><!-- --></A><H3> | |
| toDates</H3> | |
| <PRE> | |
| public java.util.Date[] <B>toDates</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be converted | |
| <DT><B>Returns:</B><DD>an array of Date objects derived from the specified value, | |
| or <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toDates(java.util.Collection)"><!-- --></A><H3> | |
| toDates</H3> | |
| <PRE> | |
| public java.util.Date[] <B>toDates</B>(java.util.Collection values)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>values</CODE> - the collection of values to be converted | |
| <DT><B>Returns:</B><DD>an array of Date objects derived from the specified values, | |
| or <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toCalendars(java.lang.Object)"><!-- --></A><H3> | |
| toCalendars</H3> | |
| <PRE> | |
| public java.util.Calendar[] <B>toCalendars</B>(java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be converted | |
| <DT><B>Returns:</B><DD>an array of Calendar objects derived from the specified value, | |
| or <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toCalendars(java.util.Collection)"><!-- --></A><H3> | |
| toCalendars</H3> | |
| <PRE> | |
| public java.util.Calendar[] <B>toCalendars</B>(java.util.Collection values)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>values</CODE> - the collection of values to be converted | |
| <DT><B>Returns:</B><DD>an array of Calendar objects derived from the specified values, | |
| or <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="parseBoolean(java.lang.String)"><!-- --></A><H3> | |
| parseBoolean</H3> | |
| <PRE> | |
| protected java.lang.Boolean <B>parseBoolean</B>(java.lang.String value)</PRE> | |
| <DL> | |
| <DD>Converts a parameter value into a <CODE>Boolean</CODE> | |
| Sub-classes can override to allow for customized boolean parsing. | |
| (e.g. to handle "Yes/No" or "T/F") | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the string to be parsed | |
| <DT><B>Returns:</B><DD>the value as a <CODE>Boolean</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="parseStringList(java.lang.String)"><!-- --></A><H3> | |
| parseStringList</H3> | |
| <PRE> | |
| protected java.lang.String[] <B>parseStringList</B>(java.lang.String value)</PRE> | |
| <DL> | |
| <DD>Converts a single String value into an array of Strings by splitting | |
| it on the tool's set stringsDelimiter. The default stringsDelimiter is a comma, | |
| and by default, all strings parsed out are trimmed before returning. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="parseLocale(java.lang.String)"><!-- --></A><H3> | |
| parseLocale</H3> | |
| <PRE> | |
| protected java.util.Locale <B>parseLocale</B>(java.lang.String value)</PRE> | |
| <DL> | |
| <DD>Converts a String value into a Locale. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="parseNumber(java.lang.String)"><!-- --></A><H3> | |
| parseNumber</H3> | |
| <PRE> | |
| public java.lang.Number <B>parseNumber</B>(java.lang.String value)</PRE> | |
| <DL> | |
| <DD>Converts an object to an instance of <CODE>Number</CODE> using the | |
| format returned by <A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#getNumberFormat()"><CODE>getNumberFormat()</CODE></A> and the default <CODE>Locale</CODE> | |
| if the object is not already an instance of Number. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the string to parse | |
| <DT><B>Returns:</B><DD>the string as a <CODE>Number</CODE> or <code>null</code> if no | |
| conversion is possible</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="parseNumber(java.lang.String, java.lang.String)"><!-- --></A><H3> | |
| parseNumber</H3> | |
| <PRE> | |
| public java.lang.Number <B>parseNumber</B>(java.lang.String value, | |
| java.lang.String format)</PRE> | |
| <DL> | |
| <DD>Converts an object to an instance of <CODE>Number</CODE> using the | |
| specified format and the <CODE>Locale</CODE> returned by | |
| <A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html#getLocale()"><CODE>LocaleConfig.getLocale()</CODE></A>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - - the string to parse<DD><CODE>format</CODE> - - the format the number is in | |
| <DT><B>Returns:</B><DD>the string as a <CODE>Number</CODE> or <code>null</code> if no | |
| conversion is possible<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#parseNumber(java.lang.String, java.lang.String, java.lang.Object)"><CODE>parseNumber(String value, String format, Object locale)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="parseNumber(java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
| parseNumber</H3> | |
| <PRE> | |
| public java.lang.Number <B>parseNumber</B>(java.lang.String value, | |
| java.lang.Object locale)</PRE> | |
| <DL> | |
| <DD>Converts an object to an instance of <CODE>Number</CODE> using the | |
| configured number format and the specified <CODE>Locale</CODE>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - - the string to parse<DD><CODE>locale</CODE> - - the Locale to use | |
| <DT><B>Returns:</B><DD>the string as a <CODE>Number</CODE> or <code>null</code> if no | |
| conversion is possible<DT><B>See Also:</B><DD><CODE>NumberFormat.parse(java.lang.String, java.text.ParsePosition)</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="parseNumber(java.lang.String, java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
| parseNumber</H3> | |
| <PRE> | |
| public java.lang.Number <B>parseNumber</B>(java.lang.String value, | |
| java.lang.String format, | |
| java.lang.Object locale)</PRE> | |
| <DL> | |
| <DD>Converts an object to an instance of <CODE>Number</CODE> using the | |
| specified format and <CODE>Locale</CODE>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - - the string to parse<DD><CODE>format</CODE> - - the format the number is in<DD><CODE>locale</CODE> - - the Locale to use | |
| <DT><B>Returns:</B><DD>the string as a <CODE>Number</CODE> or <code>null</code> if no | |
| conversion is possible<DT><B>See Also:</B><DD><CODE>NumberFormat.parse(java.lang.String, java.text.ParsePosition)</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="parseDate(java.lang.String)"><!-- --></A><H3> | |
| parseDate</H3> | |
| <PRE> | |
| public java.util.Date <B>parseDate</B>(java.lang.String value)</PRE> | |
| <DL> | |
| <DD>Converts a string to an instance of <CODE>Date</CODE>, | |
| using the configured date parsing format, the configured default | |
| <CODE>Locale</CODE>, and the system's default <CODE>TimeZone</CODE> to parse it. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the date to convert | |
| <DT><B>Returns:</B><DD>the object as a <CODE>Date</CODE> or <code>null</code> if no | |
| conversion is possible</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="parseDate(java.lang.String, java.lang.String)"><!-- --></A><H3> | |
| parseDate</H3> | |
| <PRE> | |
| public java.util.Date <B>parseDate</B>(java.lang.String value, | |
| java.lang.String format)</PRE> | |
| <DL> | |
| <DD>Converts a string to an instance of <CODE>Date</CODE> using the | |
| specified format,the configured default <CODE>Locale</CODE>, | |
| and the system's default <CODE>TimeZone</CODE> to parse it. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - - the date to convert<DD><CODE>format</CODE> - - the format the date is in | |
| <DT><B>Returns:</B><DD>the string as a <CODE>Date</CODE> or <code>null</code> if no | |
| conversion is possible<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/ConversionUtils.html#toDate(java.lang.String, java.lang.String, java.util.Locale, java.util.TimeZone)"><CODE>ConversionUtils.toDate(String str, String format, Locale locale, TimeZone timezone)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="parseDate(java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
| parseDate</H3> | |
| <PRE> | |
| public java.util.Date <B>parseDate</B>(java.lang.String value, | |
| java.lang.Object locale)</PRE> | |
| <DL> | |
| <DD>Converts a string to an instance of <CODE>Date</CODE> using the | |
| configured date format and specified <CODE>Locale</CODE> to parse it. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - - the date to convert<DD><CODE>locale</CODE> - - the Locale to use | |
| <DT><B>Returns:</B><DD>the string as a <CODE>Date</CODE> or <code>null</code> if no | |
| conversion is possible<DT><B>See Also:</B><DD><CODE>SimpleDateFormat.parse(java.lang.String, java.text.ParsePosition)</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="parseDate(java.lang.String, java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
| parseDate</H3> | |
| <PRE> | |
| public java.util.Date <B>parseDate</B>(java.lang.String value, | |
| java.lang.String format, | |
| java.lang.Object locale)</PRE> | |
| <DL> | |
| <DD>Converts a string to an instance of <CODE>Date</CODE> using the | |
| specified format and <CODE>Locale</CODE> to parse it. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - - the date to convert<DD><CODE>format</CODE> - - the format the date is in<DD><CODE>locale</CODE> - - the Locale to use | |
| <DT><B>Returns:</B><DD>the string as a <CODE>Date</CODE> or <code>null</code> if no | |
| conversion is possible<DT><B>See Also:</B><DD><CODE>SimpleDateFormat.parse(java.lang.String, java.text.ParsePosition)</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="parseDate(java.lang.String, java.lang.String, java.lang.Object, java.util.TimeZone)"><!-- --></A><H3> | |
| parseDate</H3> | |
| <PRE> | |
| public java.util.Date <B>parseDate</B>(java.lang.String value, | |
| java.lang.String format, | |
| java.lang.Object locale, | |
| java.util.TimeZone timezone)</PRE> | |
| <DL> | |
| <DD>Converts a string to an instance of <CODE>Date</CODE> using the | |
| specified format, <CODE>Locale</CODE>, and <CODE>TimeZone</CODE>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - - the date to convert<DD><CODE>format</CODE> - - the format the date is in<DD><CODE>locale</CODE> - - the Locale to use<DD><CODE>timezone</CODE> - - the <CODE>TimeZone</CODE> | |
| <DT><B>Returns:</B><DD>the string as a <CODE>Date</CODE> or <code>null</code> if no | |
| conversion is possible<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html#getDateFormat()"><CODE>getDateFormat()</CODE></A>, | |
| <CODE>SimpleDateFormat.parse(java.lang.String, java.text.ParsePosition)</CODE></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/ContextTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.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/ConversionTool.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ConversionTool.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> |