You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by nb...@apache.org on 2005/10/20 20:36:27 UTC
svn commit: r326968 [6/21] - in /jakarta/velocity/tools/trunk/docs/javadoc:
./ org/apache/velocity/tools/generic/
org/apache/velocity/tools/generic/log/ org/apache/velocity/tools/struts/
org/apache/velocity/tools/view/ org/apache/velocity/tools/view/co...
Added: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/SortTool.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/SortTool.html?rev=326968&view=auto
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/SortTool.html (added)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/SortTool.html Thu Oct 20 11:34:40 2005
@@ -0,0 +1,514 @@
+<!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 Oct 20 10:35:34 PDT 2005 -->
+<TITLE>
+SortTool (Velocity Tools 1.2 Documentation)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.SortTool class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="SortTool (Velocity Tools 1.2 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/RenderTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.PropertiesComparator.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/SortTool.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="SortTool.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: <A HREF="#nested_class_summary">NESTED</A> | 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 SortTool</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.SortTool</B>
+</PRE>
+<HR>
+<DL>
+<DT><PRE>public class <B>SortTool</B><DT>extends java.lang.Object</DL>
+</PRE>
+
+<P>
+SortTool allows a user to sort a collection (or array, iterator, etc)
+ on any arbitary set of properties exposed by the objects contained
+ within the collection.
+
+ <p>The sort tool is specifically designed to use within a #foreach
+ but you may find other uses for it.</p>
+
+ <p>The sort tool can handle all of the collection types supported by
+ #foreach and the same constraints apply as well as the following.
+ Every object in the collection must support the set of properties
+ selected to sort on. Each property which is to be sorted on must
+ return one of the follow:
+ <ul>
+ <li>Primitive type: e.g. int, char, long etc</li>
+ <li>Standard Object: e.g. String, Integer, Long etc</li>
+ <li>Object which implements the Comparable interface.</li>
+ </ul>
+ </p>
+
+ <p>During the sort operation all properties are compared by calling
+ compareTo() with the exception of Strings for which
+ compareToIgnoreCase() is called.</p>
+
+ <p>The sort is performed by calling Collections.sort() after
+ marshalling the collection to sort into an appropriate collection type.
+ The original collection will not be re-ordered; a new list containing
+ the sorted elements will always be returned.</p>
+
+ <p>The tool is used as follows:
+ <pre>
+ Single Property Sort
+ #foreach($obj in $sorter.sort($objects, "name"))
+ $obj.name Ordinal= $obj.ordinal
+ #end
+ End
+
+ Multiple Property Sort
+ #foreach($obj in $sorter.sort($objects, ["name", "ordinal"]))
+ $obj.name, $obj.ordinal
+ #end
+ End
+ </pre>
+
+ The sort method takes two parameters a collection and a property name
+ or an array of property names. The property names and corresponding
+ methods must conform to java bean standards since commons-beanutils
+ is used to extract the property values.</p>
+
+ <p>By default the sort tool sorts ascending, you can override this by
+ adding a sort type suffix to any property name.</p>
+
+ <p>The supported suffixes are:
+ <pre>
+ For ascending
+ :asc
+ For descending
+ :desc
+
+ Example
+ #foreach($obj in $sorter.sort($objects, ["name:asc", "ordinal:desc"]))
+ $obj.name, $obj.ordinal
+ #end
+ </pre><p>
+
+ <p>This will sort first by Name in ascending order and then by Ordinal
+ in descending order, of course you could have left the :asc off of the
+ 'Name' property as ascending is always the default.</p>
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.2</DD>
+<DT><B>Version:</B></DT>
+ <DD>$Id: SortTool.java 72079 2004-07-22 01:27:12Z nbubna $</DD>
+<DT><B>Author:</B></DT>
+ <DD>S. Brett Sutton, Nathan Bubna</DD>
+</DL>
+<HR>
+
+<P>
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+
+<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> class</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.PropertiesComparator.html" title="class in org.apache.velocity.tools.generic">SortTool.PropertiesComparator</A></B></CODE>
+
+<BR>
+ Does all of the comparisons</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/SortTool.html#SortTool()">SortTool</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 static java.lang.Comparable</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.html#getComparable(java.lang.Object, java.lang.String)">getComparable</A></B>(java.lang.Object object,
+ java.lang.String property)</CODE>
+
+<BR>
+ Safely retrieves the comparable value for the specified property
+ from the specified object.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected java.util.Collection</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.html#internalSort(java.util.List, java.util.List)">internalSort</A></B>(java.util.List list,
+ java.util.List properties)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Collection</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.html#sort(java.util.Collection)">sort</A></B>(java.util.Collection collection)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Collection</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.html#sort(java.util.Collection, java.util.List)">sort</A></B>(java.util.Collection collection,
+ java.util.List properties)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Collection</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.html#sort(java.util.Map)">sort</A></B>(java.util.Map map)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Collection</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.html#sort(java.util.Map, java.util.List)">sort</A></B>(java.util.Map map,
+ java.util.List properties)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Collection</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.html#sort(java.lang.Object[])">sort</A></B>(java.lang.Object[] array)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Collection</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.html#sort(java.lang.Object[], java.util.List)">sort</A></B>(java.lang.Object[] array,
+ java.util.List properties)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Collection</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.html#sort(java.lang.Object, java.lang.String)">sort</A></B>(java.lang.Object object,
+ java.lang.String property)</CODE>
+
+<BR>
+ Sorts the collection on a single property.</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="SortTool()"><!-- --></A><H3>
+SortTool</H3>
+<PRE>
+public <B>SortTool</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="sort(java.util.Collection)"><!-- --></A><H3>
+sort</H3>
+<PRE>
+public java.util.Collection <B>sort</B>(java.util.Collection collection)</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="sort(java.lang.Object[])"><!-- --></A><H3>
+sort</H3>
+<PRE>
+public java.util.Collection <B>sort</B>(java.lang.Object[] array)</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="sort(java.util.Map)"><!-- --></A><H3>
+sort</H3>
+<PRE>
+public java.util.Collection <B>sort</B>(java.util.Map map)</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="sort(java.lang.Object, java.lang.String)"><!-- --></A><H3>
+sort</H3>
+<PRE>
+public java.util.Collection <B>sort</B>(java.lang.Object object,
+ java.lang.String property)</PRE>
+<DL>
+<DD>Sorts the collection on a single property.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>object</CODE> - the collection to be sorted.<DD><CODE>property</CODE> - the property to sort on.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="sort(java.util.Collection, java.util.List)"><!-- --></A><H3>
+sort</H3>
+<PRE>
+public java.util.Collection <B>sort</B>(java.util.Collection collection,
+ java.util.List properties)</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="sort(java.util.Map, java.util.List)"><!-- --></A><H3>
+sort</H3>
+<PRE>
+public java.util.Collection <B>sort</B>(java.util.Map map,
+ java.util.List properties)</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="sort(java.lang.Object[], java.util.List)"><!-- --></A><H3>
+sort</H3>
+<PRE>
+public java.util.Collection <B>sort</B>(java.lang.Object[] array,
+ java.util.List properties)</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="internalSort(java.util.List, java.util.List)"><!-- --></A><H3>
+internalSort</H3>
+<PRE>
+protected java.util.Collection <B>internalSort</B>(java.util.List list,
+ java.util.List properties)</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getComparable(java.lang.Object, java.lang.String)"><!-- --></A><H3>
+getComparable</H3>
+<PRE>
+protected static java.lang.Comparable <B>getComparable</B>(java.lang.Object object,
+ java.lang.String property)</PRE>
+<DL>
+<DD>Safely retrieves the comparable value for the specified property
+ from the specified object. Subclasses that wish to perform more
+ advanced, efficient, or just different property retrieval methods
+ should override this method to do so.
+<P>
+<DD><DL>
+</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/RenderTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.PropertiesComparator.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/SortTool.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="SortTool.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: <A HREF="#nested_class_summary">NESTED</A> | 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 Apache Software Foundation
+</BODY>
+</HTML>
Added: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/ValueParser.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/ValueParser.html?rev=326968&view=auto
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/ValueParser.html (added)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/ValueParser.html Thu Oct 20 11:34:40 2005
@@ -0,0 +1,758 @@
+<!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 Oct 20 10:35:34 PDT 2005 -->
+<TITLE>
+ValueParser (Velocity Tools 1.2 Documentation)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.ValueParser class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="ValueParser (Velocity Tools 1.2 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/SortTool.PropertiesComparator.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
+ NEXT CLASS</FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/ValueParser.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ValueParser.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 ValueParser</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.ValueParser</B>
+</PRE>
+<DL>
+<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html" title="class in org.apache.velocity.tools.view.tools">ParameterParser</A></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public class <B>ValueParser</B><DT>extends java.lang.Object</DL>
+</PRE>
+
+<P>
+<p>Utility class for easy parsing of String values held in a Map.</p>
+ <p><pre>
+ Template example(s):
+ $parser.foo -> bar
+ $parser.getNumber('baz') -> 12.6
+ $parser.getInt('baz') -> 12
+ $parser.getNumbers('foo') -> [12.6]
+
+ Toolbox configuration:
+ <tool>
+ <key>parser</key>
+ <class>org.apache.velocity.generic.Parser</class>
+ </tool>
+ </pre></p>
+
+ <p>This comes in very handy when parsing parameters.</p>
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.2</DD>
+<DT><B>Version:</B></DT>
+ <DD>$Revision: 326944 $ $Date: 2005-10-20 09:48:02 -0700 (Thu, 20 Oct 2005) $</DD>
+<DT><B>Author:</B></DT>
+ <DD><a href="mailto:nathan@esha.com">Nathan Bubna</a></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>private java.util.Map</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#source">source</A></B></CODE>
+
+<BR>
+ </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/ValueParser.html#ValueParser()">ValueParser</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#ValueParser(java.util.Map)">ValueParser</A></B>(java.util.Map source)</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> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#exists(java.lang.String)">exists</A></B>(java.lang.String key)</CODE>
+
+<BR>
+ Convenience method for checking whether a certain parameter exists.</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/ValueParser.html#get(java.lang.String)">get</A></B>(java.lang.String key)</CODE>
+
+<BR>
+ Convenience method for use in Velocity templates.</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/ValueParser.html#getBoolean(java.lang.String)">getBoolean</A></B>(java.lang.String key)</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/ValueParser.html#getBoolean(java.lang.String, boolean)">getBoolean</A></B>(java.lang.String key,
+ boolean alternate)</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/ValueParser.html#getBoolean(java.lang.String, java.lang.Boolean)">getBoolean</A></B>(java.lang.String key,
+ java.lang.Boolean alternate)</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/ValueParser.html#getBooleans(java.lang.String)">getBooleans</A></B>(java.lang.String key)</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/ValueParser.html#getDouble(java.lang.String, double)">getDouble</A></B>(java.lang.String key,
+ double alternate)</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/ValueParser.html#getDoubles(java.lang.String)">getDoubles</A></B>(java.lang.String key)</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/ValueParser.html#getInt(java.lang.String, int)">getInt</A></B>(java.lang.String key,
+ int alternate)</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/ValueParser.html#getInts(java.lang.String)">getInts</A></B>(java.lang.String key)</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/ValueParser.html#getNumber(java.lang.String)">getNumber</A></B>(java.lang.String key)</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/ValueParser.html#getNumber(java.lang.String, java.lang.Number)">getNumber</A></B>(java.lang.String key,
+ java.lang.Number alternate)</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/ValueParser.html#getNumbers(java.lang.String)">getNumbers</A></B>(java.lang.String key)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected java.util.Map</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#getSource()">getSource</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/ValueParser.html#getString(java.lang.String)">getString</A></B>(java.lang.String key)</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/ValueParser.html#getString(java.lang.String, java.lang.String)">getString</A></B>(java.lang.String key,
+ java.lang.String alternate)</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/ValueParser.html#getStrings(java.lang.String)">getStrings</A></B>(java.lang.String key)</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/ValueParser.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>protected java.lang.Number</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#parseNumber(java.lang.String)">parseNumber</A></B>(java.lang.String value)</CODE>
+
+<BR>
+ Converts a parameter value into a <CODE>Number</CODE>
+ This is used as the base for all numeric parsing methods.</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/ValueParser.html#setSource(java.util.Map)">setSource</A></B>(java.util.Map source)</CODE>
+
+<BR>
+ </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="source"><!-- --></A><H3>
+source</H3>
+<PRE>
+private java.util.Map <B>source</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="ValueParser()"><!-- --></A><H3>
+ValueParser</H3>
+<PRE>
+public <B>ValueParser</B>()</PRE>
+<DL>
+</DL>
+<HR>
+
+<A NAME="ValueParser(java.util.Map)"><!-- --></A><H3>
+ValueParser</H3>
+<PRE>
+public <B>ValueParser</B>(java.util.Map source)</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="setSource(java.util.Map)"><!-- --></A><H3>
+setSource</H3>
+<PRE>
+protected void <B>setSource</B>(java.util.Map source)</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getSource()"><!-- --></A><H3>
+getSource</H3>
+<PRE>
+protected java.util.Map <B>getSource</B>()</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="exists(java.lang.String)"><!-- --></A><H3>
+exists</H3>
+<PRE>
+public boolean <B>exists</B>(java.lang.String key)</PRE>
+<DL>
+<DD>Convenience method for checking whether a certain parameter exists.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the parameter's key
+<DT><B>Returns:</B><DD><code>true</code> if a parameter exists for the specified
+ key; otherwise, returns <code>false</code>.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="get(java.lang.String)"><!-- --></A><H3>
+get</H3>
+<PRE>
+public java.lang.String <B>get</B>(java.lang.String key)</PRE>
+<DL>
+<DD>Convenience method for use in Velocity templates.
+ This allows for easy "dot" access to parameters.
+
+ e.g. $params.foo instead of $params.getString('foo')
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the parameter's key
+<DT><B>Returns:</B><DD>parameter matching the specified key or
+ <code>null</code> if there is no matching
+ parameter</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getString(java.lang.String)"><!-- --></A><H3>
+getString</H3>
+<PRE>
+public java.lang.String <B>getString</B>(java.lang.String key)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the parameter's key
+<DT><B>Returns:</B><DD>parameter matching the specified key or
+ <code>null</code> if there is no matching
+ parameter</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getString(java.lang.String, java.lang.String)"><!-- --></A><H3>
+getString</H3>
+<PRE>
+public java.lang.String <B>getString</B>(java.lang.String key,
+ java.lang.String alternate)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key<DD><CODE>alternate</CODE> - The alternate value
+<DT><B>Returns:</B><DD>parameter matching the specified key or the
+ specified alternate String if there is no matching
+ parameter</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getBoolean(java.lang.String)"><!-- --></A><H3>
+getBoolean</H3>
+<PRE>
+public java.lang.Boolean <B>getBoolean</B>(java.lang.String key)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key
+<DT><B>Returns:</B><DD>a <CODE>Boolean</CODE> object for the specified key or
+ <code>null</code> if no matching parameter is found</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getBoolean(java.lang.String, boolean)"><!-- --></A><H3>
+getBoolean</H3>
+<PRE>
+public boolean <B>getBoolean</B>(java.lang.String key,
+ boolean alternate)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key<DD><CODE>alternate</CODE> - The alternate boolean value
+<DT><B>Returns:</B><DD>boolean value for the specified key or the
+ alternate boolean is no value is found</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getBoolean(java.lang.String, java.lang.Boolean)"><!-- --></A><H3>
+getBoolean</H3>
+<PRE>
+public java.lang.Boolean <B>getBoolean</B>(java.lang.String key,
+ java.lang.Boolean alternate)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key<DD><CODE>alternate</CODE> - the alternate <CODE>Boolean</CODE>
+<DT><B>Returns:</B><DD>a <CODE>Boolean</CODE> for the specified key or the specified
+ alternate if no matching parameter is found</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getNumber(java.lang.String)"><!-- --></A><H3>
+getNumber</H3>
+<PRE>
+public java.lang.Number <B>getNumber</B>(java.lang.String key)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key
+<DT><B>Returns:</B><DD>a <CODE>Number</CODE> for the specified key or
+ <code>null</code> if no matching parameter is found</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getNumber(java.lang.String, java.lang.Number)"><!-- --></A><H3>
+getNumber</H3>
+<PRE>
+public java.lang.Number <B>getNumber</B>(java.lang.String key,
+ java.lang.Number alternate)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key<DD><CODE>alternate</CODE> - The alternate Number
+<DT><B>Returns:</B><DD>a Number for the specified key or the specified
+ alternate if no matching parameter is found</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getInt(java.lang.String, int)"><!-- --></A><H3>
+getInt</H3>
+<PRE>
+public int <B>getInt</B>(java.lang.String key,
+ int alternate)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key<DD><CODE>alternate</CODE> - The alternate int value
+<DT><B>Returns:</B><DD>the int value for the specified key or the specified
+ alternate value if no matching parameter is found</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getDouble(java.lang.String, double)"><!-- --></A><H3>
+getDouble</H3>
+<PRE>
+public double <B>getDouble</B>(java.lang.String key,
+ double alternate)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key<DD><CODE>alternate</CODE> - The alternate double value
+<DT><B>Returns:</B><DD>the double value for the specified key or the specified
+ alternate value if no matching parameter is found</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getStrings(java.lang.String)"><!-- --></A><H3>
+getStrings</H3>
+<PRE>
+public java.lang.String[] <B>getStrings</B>(java.lang.String key)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key for the desired parameter
+<DT><B>Returns:</B><DD>an array of String objects containing all of the values
+ associated with the given key, or <code>null</code>
+ if the no values are associated with the given key</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getBooleans(java.lang.String)"><!-- --></A><H3>
+getBooleans</H3>
+<PRE>
+public java.lang.Boolean[] <B>getBooleans</B>(java.lang.String key)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key for the desired parameter
+<DT><B>Returns:</B><DD>an array of Boolean objects associated with the given key.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getNumbers(java.lang.String)"><!-- --></A><H3>
+getNumbers</H3>
+<PRE>
+public java.lang.Number[] <B>getNumbers</B>(java.lang.String key)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key for the desired parameter
+<DT><B>Returns:</B><DD>an array of Number objects associated with the given key,
+ or <code>null</code> if Numbers are not associated with it.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getInts(java.lang.String)"><!-- --></A><H3>
+getInts</H3>
+<PRE>
+public int[] <B>getInts</B>(java.lang.String key)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key for the desired parameter
+<DT><B>Returns:</B><DD>an array of int values associated with the given key,
+ or <code>null</code> if numbers are not associated with it.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getDoubles(java.lang.String)"><!-- --></A><H3>
+getDoubles</H3>
+<PRE>
+public double[] <B>getDoubles</B>(java.lang.String key)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key for the desired parameter
+<DT><B>Returns:</B><DD>an array of double values associated with the given key,
+ or <code>null</code> if numbers are not associated with it.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="parseNumber(java.lang.String)"><!-- --></A><H3>
+parseNumber</H3>
+<PRE>
+protected java.lang.Number <B>parseNumber</B>(java.lang.String value)
+ throws java.lang.NumberFormatException</PRE>
+<DL>
+<DD>Converts a parameter value into a <CODE>Number</CODE>
+ This is used as the base for all numeric parsing methods. So,
+ sub-classes can override to allow for customized number parsing.
+ (e.g. to handle fractions, compound numbers, etc.)
+<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>Number</CODE>
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.NumberFormatException</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>
+<!-- ========= 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/SortTool.PropertiesComparator.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
+ NEXT CLASS</FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/ValueParser.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ValueParser.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 Apache Software Foundation
+</BODY>
+</HTML>
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/CommonsLogLogSystem.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/CommonsLogLogSystem.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/CommonsLogLogSystem.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/CommonsLogLogSystem.html Thu Oct 20 11:34:40 2005
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.4.2_01) on Fri Mar 12 02:01:01 GMT 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:34 PDT 2005 -->
<TITLE>
-CommonsLogLogSystem (Velocity Tools 1.1-dev Documentation)
+CommonsLogLogSystem (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.log.CommonsLogLogSystem class">
@@ -14,9 +14,11 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="CommonsLogLogSystem (Velocity Tools 1.1-dev Documentation)";
+ parent.document.title="CommonsLogLogSystem (Velocity Tools 1.2 Documentation)";
}
</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
</HEAD>
@@ -28,7 +30,7 @@
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -52,7 +54,7 @@
PREV CLASS
<A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html" title="class in org.apache.velocity.tools.generic.log"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/generic/log/CommonsLogLogSystem.html" target="_top"><B>FRAMES</B></A>
<A HREF="CommonsLogLogSystem.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -65,6 +67,7 @@
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
<TR>
@@ -86,14 +89,15 @@
Class CommonsLogLogSystem</H2>
<PRE>
java.lang.Object
- <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.velocity.tools.generic.log.CommonsLogLogSystem</B>
+ <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.log.CommonsLogLogSystem</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>org.apache.velocity.runtime.log.LogSystem</DD>
</DL>
<HR>
<DL>
-<DT>public class <B>CommonsLogLogSystem</B><DT>extends java.lang.Object<DT>implements org.apache.velocity.runtime.log.LogSystem</DL>
+<DT><PRE>public class <B>CommonsLogLogSystem</B><DT>extends java.lang.Object<DT>implements org.apache.velocity.runtime.log.LogSystem</DL>
+</PRE>
<P>
Redirects Velocity's LogSystem messages to commons-logging.
@@ -119,23 +123,20 @@
<DT><B>Since:</B></DT>
<DD>VelocityTools 1.1</DD>
<DT><B>Version:</B></DT>
- <DD>$Id: CommonsLogLogSystem.html,v 1.7 2004/03/12 02:06:57 marino Exp $</DD>
+ <DD>$Id$</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
</DL>
<HR>
<P>
-<!-- ======== NESTED CLASS SUMMARY ======== -->
-
-
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Field Summary</B></FONT></TD>
+<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">
@@ -165,7 +166,7 @@
<A NAME="fields_inherited_from_class_org.apache.velocity.runtime.log.LogSystem"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TD><B>Fields inherited from interface org.apache.velocity.runtime.log.LogSystem</B></TD>
+<TH ALIGN="left"><B>Fields inherited from interface org.apache.velocity.runtime.log.LogSystem</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>DEBUG_ID, DEBUG_ON, ERROR_ID, INFO_ID, WARN_ID</CODE></TD>
@@ -177,8 +178,8 @@
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Constructor Summary</B></FONT></TD>
+<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/log/CommonsLogLogSystem.html#CommonsLogLogSystem()">CommonsLogLogSystem</A></B>()</CODE>
@@ -193,8 +194,8 @@
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Method Summary</B></FONT></TD>
+<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">
@@ -217,7 +218,7 @@
<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">
-<TD><B>Methods inherited from class java.lang.Object</B></TD>
+<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>
@@ -231,8 +232,8 @@
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Field Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
@@ -276,8 +277,8 @@
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Constructor Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
@@ -293,8 +294,8 @@
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Method Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
@@ -341,7 +342,7 @@
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -365,7 +366,7 @@
PREV CLASS
<A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html" title="class in org.apache.velocity.tools.generic.log"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/generic/log/CommonsLogLogSystem.html" target="_top"><B>FRAMES</B></A>
<A HREF="CommonsLogLogSystem.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -377,6 +378,7 @@
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html Thu Oct 20 11:34:40 2005
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.4.2_01) on Fri Mar 12 02:01:02 GMT 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:34 PDT 2005 -->
<TITLE>
-LogSystemCommonsLog (Velocity Tools 1.1-dev Documentation)
+LogSystemCommonsLog (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.log.LogSystemCommonsLog class">
@@ -14,9 +14,11 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="LogSystemCommonsLog (Velocity Tools 1.1-dev Documentation)";
+ parent.document.title="LogSystemCommonsLog (Velocity Tools 1.2 Documentation)";
}
</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
</HEAD>
@@ -28,7 +30,7 @@
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -52,7 +54,7 @@
<A HREF="../../../../../../org/apache/velocity/tools/generic/log/CommonsLogLogSystem.html" title="class in org.apache.velocity.tools.generic.log"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html" target="_top"><B>FRAMES</B></A>
<A HREF="LogSystemCommonsLog.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -65,6 +67,7 @@
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
<TR>
@@ -86,47 +89,57 @@
Class LogSystemCommonsLog</H2>
<PRE>
java.lang.Object
- <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.velocity.tools.generic.log.LogSystemCommonsLog</B>
+ <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.log.LogSystemCommonsLog</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>org.apache.commons.logging.Log</DD>
</DL>
<HR>
<DL>
-<DT>public class <B>LogSystemCommonsLog</B><DT>extends java.lang.Object<DT>implements org.apache.commons.logging.Log</DL>
+<DT><PRE>public class <B>LogSystemCommonsLog</B><DT>extends java.lang.Object<DT>implements org.apache.commons.logging.Log</DL>
+</PRE>
<P>
Redirects commons-logging messages to Velocity's LogSystem.
<p>To use, specify this class in your commons-logging.properties:
<code>
- org.apache.commons.logging.Log=org.apache.velocity.tools.generic.log.LogSystemCommonsLog
+ org.apache.commons.logging.Log=org.apache.velocity.tools.log.LogSystemCommonsLog
</code>
</p>
<P>
<P>
<DL>
-<DT><B>Since:</B></DT>
- <DD>VelocityTools 1.1</DD>
<DT><B>Version:</B></DT>
- <DD>$Id: LogSystemCommonsLog.html,v 1.7 2004/03/12 02:06:57 marino Exp $</DD>
-<DT><B>Author:</B></DT>
- <DD><a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
+ <DD>$Id$</DD>
</DL>
<HR>
<P>
-<!-- ======== NESTED CLASS SUMMARY ======== -->
-
-
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Field Summary</B></FONT></TD>
+<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>protected static org.apache.velocity.app.VelocityEngine</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html#handler">handler</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/log/LogSystemCommonsLog.html#name">name</A></B></CODE>
+
+<BR>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -143,29 +156,35 @@
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Constructor Summary</B></FONT></TD>
+<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/log/LogSystemCommonsLog.html#LogSystemCommonsLog()">LogSystemCommonsLog</A></B>()</CODE>
<BR>
- Default constructor</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html#LogSystemCommonsLog(boolean)">LogSystemCommonsLog</A></B>(boolean pst)</CODE>
<BR>
Lets you set whether or not this instance should print the
- full stack trace of exceptions and errors passed to it.
+ full stack trace of exceptions and errors passed to it.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html#LogSystemCommonsLog(boolean, java.lang.String)">LogSystemCommonsLog</A></B>(boolean pst,
+ java.lang.String name)</CODE>
- </TD>
+<BR>
+ Lets you set whether or not this instance should print the
+ full stack trace of exceptions and errors passed to it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html#LogSystemCommonsLog(java.lang.String)">LogSystemCommonsLog</A></B>(java.lang.String name)</CODE>
<BR>
- Meaningless constructor to make commons-logging happy.</TD>
+ </TD>
</TR>
</TABLE>
@@ -174,8 +193,8 @@
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Method Summary</B></FONT></TD>
+<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">
@@ -217,8 +236,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html#fatal(java.lang.Object)">fatal</A></B>(java.lang.Object message)</CODE>
<BR>
- Passes messages to Velocity's LogSystem at "ERROR" level.
- </TD>
+ Passes messages to Velocity's LogSystem at "ERROR" level.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -227,8 +245,7 @@
java.lang.Throwable t)</CODE>
<BR>
- Passes messages to Velocity's LogSystem at "ERROR" level.
- </TD>
+ Passes messages to Velocity's LogSystem at "ERROR" level.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -253,7 +270,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html#isDebugEnabled()">isDebugEnabled</A></B>()</CODE>
<BR>
- Always returns true since Velocity's LogSystem
+ Always returns true since Velocity's LogSystem
doesn't provide this information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -262,7 +279,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html#isErrorEnabled()">isErrorEnabled</A></B>()</CODE>
<BR>
- Always returns true since Velocity's LogSystem
+ Always returns true since Velocity's LogSystem
doesn't provide this information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -271,7 +288,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html#isFatalEnabled()">isFatalEnabled</A></B>()</CODE>
<BR>
- Always returns true since Velocity's LogSystem
+ Always returns true since Velocity's LogSystem
doesn't provide this information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -280,7 +297,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html#isInfoEnabled()">isInfoEnabled</A></B>()</CODE>
<BR>
- Always returns true since Velocity's LogSystem
+ Always returns true since Velocity's LogSystem
doesn't provide this information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -289,7 +306,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html#isTraceEnabled()">isTraceEnabled</A></B>()</CODE>
<BR>
- Always returns true since Velocity's LogSystem
+ Always returns true since Velocity's LogSystem
doesn't provide this information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -298,7 +315,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html#isWarnEnabled()">isWarnEnabled</A></B>()</CODE>
<BR>
- Always returns true since Velocity's LogSystem
+ Always returns true since Velocity's LogSystem
doesn't provide this information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -322,12 +339,19 @@
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html#setVelocityEngine(org.apache.velocity.app.VelocityEngine)">setVelocityEngine</A></B>(org.apache.velocity.app.VelocityEngine engine)</CODE>
+
+<BR>
+ Set a VelocityEngine to handle all the log messages.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html#trace(java.lang.Object)">trace</A></B>(java.lang.Object message)</CODE>
<BR>
- Passes messages to Velocity's LogSystem at "DEBUG" level.
- </TD>
+ Passes messages to Velocity's LogSystem at "DEBUG" level.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -336,8 +360,7 @@
java.lang.Throwable t)</CODE>
<BR>
- Passes messages to Velocity's LogSystem at "DEBUG" level.
- </TD>
+ Passes messages to Velocity's LogSystem at "DEBUG" level.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -360,7 +383,7 @@
<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">
-<TD><B>Methods inherited from class java.lang.Object</B></TD>
+<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>
@@ -374,11 +397,21 @@
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Field Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
+<A NAME="handler"><!-- --></A><H3>
+handler</H3>
+<PRE>
+protected static org.apache.velocity.app.VelocityEngine <B>handler</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+<HR>
+
<A NAME="printStackTrace"><!-- --></A><H3>
printStackTrace</H3>
<PRE>
@@ -387,14 +420,24 @@
<DL>
</DL>
</DL>
+<HR>
+
+<A NAME="name"><!-- --></A><H3>
+name</H3>
+<PRE>
+private java.lang.String <B>name</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">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Constructor Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
@@ -403,8 +446,6 @@
<PRE>
public <B>LogSystemCommonsLog</B>()</PRE>
<DL>
-<DD>Default constructor
-<P>
</DL>
<HR>
@@ -413,8 +454,6 @@
<PRE>
public <B>LogSystemCommonsLog</B>(java.lang.String name)</PRE>
<DL>
-<DD>Meaningless constructor to make commons-logging happy.
-<P>
</DL>
<HR>
@@ -429,18 +468,53 @@
<p>It should be possible to create a LogFactory implementation
that takes advantage of this constructor.</p>
<P>
+<DL>
<DT><B>Parameters:</B><DD><CODE>pst</CODE> - if true, stack traces will be printed</DL>
+</DL>
+<HR>
+
+<A NAME="LogSystemCommonsLog(boolean, java.lang.String)"><!-- --></A><H3>
+LogSystemCommonsLog</H3>
+<PRE>
+public <B>LogSystemCommonsLog</B>(boolean pst,
+ java.lang.String name)</PRE>
+<DL>
+<DD>Lets you set whether or not this instance should print the
+ full stack trace of exceptions and errors passed to it.
+
+ <p>It should be possible to create a LogFactory implementation
+ that takes advantage of this constructor.</p>
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>pst</CODE> - if true, stack traces will be printed<DD><CODE>name</CODE> - the name of this logger</DL>
+</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Method Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
+<A NAME="setVelocityEngine(org.apache.velocity.app.VelocityEngine)"><!-- --></A><H3>
+setVelocityEngine</H3>
+<PRE>
+public static void <B>setVelocityEngine</B>(org.apache.velocity.app.VelocityEngine engine)</PRE>
+<DL>
+<DD>Set a VelocityEngine to handle all the log messages.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
<A NAME="log(int, java.lang.Object)"><!-- --></A><H3>
log</H3>
<PRE>
@@ -679,7 +753,7 @@
<PRE>
public boolean <B>isTraceEnabled</B>()</PRE>
<DL>
-<DD>Always returns true since Velocity's LogSystem
+<DD>Always returns true since Velocity's LogSystem
doesn't provide this information.
<P>
<DD><DL>
@@ -697,7 +771,7 @@
<PRE>
public boolean <B>isDebugEnabled</B>()</PRE>
<DL>
-<DD>Always returns true since Velocity's LogSystem
+<DD>Always returns true since Velocity's LogSystem
doesn't provide this information.
<P>
<DD><DL>
@@ -715,7 +789,7 @@
<PRE>
public boolean <B>isInfoEnabled</B>()</PRE>
<DL>
-<DD>Always returns true since Velocity's LogSystem
+<DD>Always returns true since Velocity's LogSystem
doesn't provide this information.
<P>
<DD><DL>
@@ -733,7 +807,7 @@
<PRE>
public boolean <B>isWarnEnabled</B>()</PRE>
<DL>
-<DD>Always returns true since Velocity's LogSystem
+<DD>Always returns true since Velocity's LogSystem
doesn't provide this information.
<P>
<DD><DL>
@@ -751,7 +825,7 @@
<PRE>
public boolean <B>isErrorEnabled</B>()</PRE>
<DL>
-<DD>Always returns true since Velocity's LogSystem
+<DD>Always returns true since Velocity's LogSystem
doesn't provide this information.
<P>
<DD><DL>
@@ -769,7 +843,7 @@
<PRE>
public boolean <B>isFatalEnabled</B>()</PRE>
<DL>
-<DD>Always returns true since Velocity's LogSystem
+<DD>Always returns true since Velocity's LogSystem
doesn't provide this information.
<P>
<DD><DL>
@@ -789,7 +863,7 @@
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -813,7 +887,7 @@
<A HREF="../../../../../../org/apache/velocity/tools/generic/log/CommonsLogLogSystem.html" title="class in org.apache.velocity.tools.generic.log"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html" target="_top"><B>FRAMES</B></A>
<A HREF="LogSystemCommonsLog.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -825,6 +899,7 @@
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/package-frame.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/package-frame.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/package-frame.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/package-frame.html Thu Oct 20 11:34:40 2005
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.4.2_01) on Fri Mar 12 02:01:01 GMT 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:35 PDT 2005 -->
<TITLE>
-org.apache.velocity.tools.generic.log (Velocity Tools 1.1-dev Documentation)
+org.apache.velocity.tools.generic.log (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.log package">
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/package-summary.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/package-summary.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/package-summary.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/log/package-summary.html Thu Oct 20 11:34:40 2005
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.4.2_01) on Fri Mar 12 02:01:01 GMT 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:35 PDT 2005 -->
<TITLE>
-org.apache.velocity.tools.generic.log (Velocity Tools 1.1-dev Documentation)
+org.apache.velocity.tools.generic.log (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.log package">
@@ -14,9 +14,11 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="org.apache.velocity.tools.generic.log (Velocity Tools 1.1-dev Documentation)";
+ parent.document.title="org.apache.velocity.tools.generic.log (Velocity Tools 1.2 Documentation)";
}
</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
</HEAD>
@@ -28,7 +30,7 @@
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -52,7 +54,7 @@
<A HREF="../../../../../../org/apache/velocity/tools/generic/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../../../org/apache/velocity/tools/struts/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/generic/log/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -65,6 +67,7 @@
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
</TABLE>
@@ -76,7 +79,7 @@
Package org.apache.velocity.tools.generic.log
</H2>
Contains classes created to serve as bridges between Commons-Logging and Velocity's
-LogSystem.
+LogSystem.
<P>
<B>See:</B>
<BR>
@@ -85,20 +88,16 @@
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Class Summary</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/CommonsLogLogSystem.html" title="class in org.apache.velocity.tools.generic.log">CommonsLogLogSystem</A></B></TD>
-<TD>Redirects Velocity's LogSystem messages to commons-logging.
-
- </TD>
+<TD>Redirects Velocity's LogSystem messages to commons-logging.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html" title="class in org.apache.velocity.tools.generic.log">LogSystemCommonsLog</A></B></TD>
-<TD>Redirects commons-logging messages to Velocity's LogSystem.
-
- </TD>
+<TD>Redirects commons-logging messages to Velocity's LogSystem.</TD>
</TR>
</TABLE>
@@ -111,13 +110,13 @@
<P>
Contains classes created to serve as bridges between Commons-Logging and Velocity's
LogSystem. These are useful for trying to direct Velocity's log output to another
-project's log setup or vice versa. See each classes javadoc for more information.
+project's log setup or vice versa. See each class's javadoc for more information.
<!--
##### THIS IS THE TEMPLATE FOR THE PACKAGE DOC COMMENTS. #####
##### TYPE YOUR PACKAGE COMMENTS HERE. BEGIN WITH A #####
##### ONE-SENTENCE SUMMARY STARTING WITH A VERB LIKE: #####
-Provides for....
+Provides for....
-->
<h2>Package Specification</h2>
@@ -142,6 +141,8 @@
<P>
<P>
+<DL>
+</DL>
<HR>
@@ -150,7 +151,7 @@
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -174,7 +175,7 @@
<A HREF="../../../../../../org/apache/velocity/tools/generic/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../../../org/apache/velocity/tools/struts/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/generic/log/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -186,6 +187,7 @@
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org