| <!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:12 PDT 2010 --> | |
| <TITLE> | |
| ToolInfo (VelocityTools 2.0 Documentation) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.ToolInfo class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="ToolInfo (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/ToolContext.html" title="class in org.apache.velocity.tools"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/velocity/tools/ToolInfo.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ToolInfo.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</FONT> | |
| <BR> | |
| Class ToolInfo</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.ToolInfo</B> | |
| </PRE> | |
| <DL> | |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> | |
| </DL> | |
| <DL> | |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/velocity/tools/OldToolInfo.html" title="class in org.apache.velocity.tools">OldToolInfo</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public class <B>ToolInfo</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL> | |
| </PRE> | |
| <P> | |
| Manages data needed to create instances of a tool. New instances | |
| are returned for every call to create(obj). | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Id: ToolInfo.java 511959 2007-02-26 19:24:39Z nbubna $</DD> | |
| <DT><B>Author:</B></DT> | |
| <DD>Nathan Bubna, <a href="mailto:henning@schmiedehausen.org">Henning P. Schmiedehausen</a></DD> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.velocity.tools.ToolInfo">Serialized Form</A></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.lang.Class</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#clazz">clazz</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.reflect.Method</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#configure">configure</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/ToolInfo.html#CONFIGURE_METHOD_NAME">CONFIGURE_METHOD_NAME</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/ToolInfo.html#key">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.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#properties">properties</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/ToolInfo.html#restrictTo">restrictTo</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/ToolInfo.html#restrictToIsExact">restrictToIsExact</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private static long</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#serialVersionUID">serialVersionUID</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.Boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#skipSetters">skipSetters</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/ToolInfo.html#ToolInfo(java.lang.String, java.lang.Class)">ToolInfo</A></B>(java.lang.String key, | |
| java.lang.Class clazz)</CODE> | |
| <BR> | |
| Creates a new instance using the minimum required info | |
| necessary for a tool.</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> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#addProperties(java.util.Map)">addProperties</A></B>(java.util.Map<java.lang.String,java.lang.Object> parentProps)</CODE> | |
| <BR> | |
| Adds a map of properties from a parent scope to the properties | |
| for this tool.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#combine(java.util.Map...)">combine</A></B>(java.util.Map<java.lang.String,java.lang.Object>... maps)</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/ToolInfo.html#configure(java.lang.Object, java.util.Map)">configure</A></B>(java.lang.Object tool, | |
| java.util.Map<java.lang.String,java.lang.Object> configuration)</CODE> | |
| <BR> | |
| Actually performs configuration of the newly instantiated tool | |
| using the combined final set of configuration properties.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Object</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#create(java.util.Map)">create</A></B>(java.util.Map<java.lang.String,java.lang.Object> dynamicProperties)</CODE> | |
| <BR> | |
| Returns a new instance of the tool.</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/ToolInfo.html#getClassname()">getClassname</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.reflect.Method</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#getConfigure()">getConfigure</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/ToolInfo.html#getKey()">getKey</A></B>()</CODE> | |
| <BR> | |
| Accessors</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#getProperties()">getProperties</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#getProps()">getProps</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Class</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#getToolClass()">getToolClass</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/ToolInfo.html#hasConfigure()">hasConfigure</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/ToolInfo.html#hasPermission(java.lang.String)">hasPermission</A></B>(java.lang.String path)</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/ToolInfo.html#invoke(java.lang.reflect.Method, java.lang.Object, java.lang.Object)">invoke</A></B>(java.lang.reflect.Method method, | |
| java.lang.Object tool, | |
| java.lang.Object param)</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/ToolInfo.html#isSkipSetters()">isSkipSetters</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.Object</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#newInstance()">newInstance</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Object</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolInfo.html#putProperty(java.lang.String, java.lang.Object)">putProperty</A></B>(java.lang.String name, | |
| java.lang.Object value)</CODE> | |
| <BR> | |
| Puts a new property for this tool.</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/ToolInfo.html#restrictTo(java.lang.String)">restrictTo</A></B>(java.lang.String path)</CODE> | |
| <BR> | |
| </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/ToolInfo.html#setClass(java.lang.Class)">setClass</A></B>(java.lang.Class clazz)</CODE> | |
| <BR> | |
| Tries to create an instance of the specified Class, then looks for a | |
| configure(Map<String,Object>) method.</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/ToolInfo.html#setKey(java.lang.String)">setKey</A></B>(java.lang.String key)</CODE> | |
| <BR> | |
| Mutators</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/ToolInfo.html#setProperty(java.lang.Object, java.lang.String, java.lang.Object)">setProperty</A></B>(java.lang.Object tool, | |
| java.lang.String name, | |
| java.lang.Object value)</CODE> | |
| <BR> | |
| </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/ToolInfo.html#setSkipSetters(boolean)">setSkipSetters</A></B>(boolean cfgOnly)</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="serialVersionUID"><!-- --></A><H3> | |
| serialVersionUID</H3> | |
| <PRE> | |
| private static final long <B>serialVersionUID</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.velocity.tools.ToolInfo.serialVersionUID">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="CONFIGURE_METHOD_NAME"><!-- --></A><H3> | |
| CONFIGURE_METHOD_NAME</H3> | |
| <PRE> | |
| public static final java.lang.String <B>CONFIGURE_METHOD_NAME</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.velocity.tools.ToolInfo.CONFIGURE_METHOD_NAME">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="key"><!-- --></A><H3> | |
| key</H3> | |
| <PRE> | |
| private java.lang.String <B>key</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="clazz"><!-- --></A><H3> | |
| clazz</H3> | |
| <PRE> | |
| private java.lang.Class <B>clazz</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="restrictToIsExact"><!-- --></A><H3> | |
| restrictToIsExact</H3> | |
| <PRE> | |
| private boolean <B>restrictToIsExact</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="restrictTo"><!-- --></A><H3> | |
| restrictTo</H3> | |
| <PRE> | |
| private java.lang.String <B>restrictTo</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="properties"><!-- --></A><H3> | |
| properties</H3> | |
| <PRE> | |
| private java.util.Map<java.lang.String,java.lang.Object> <B>properties</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="skipSetters"><!-- --></A><H3> | |
| skipSetters</H3> | |
| <PRE> | |
| private java.lang.Boolean <B>skipSetters</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="configure"><!-- --></A><H3> | |
| configure</H3> | |
| <PRE> | |
| private transient java.lang.reflect.Method <B>configure</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="ToolInfo(java.lang.String, java.lang.Class)"><!-- --></A><H3> | |
| ToolInfo</H3> | |
| <PRE> | |
| public <B>ToolInfo</B>(java.lang.String key, | |
| java.lang.Class clazz)</PRE> | |
| <DL> | |
| <DD>Creates a new instance using the minimum required info | |
| necessary for a tool. | |
| <P> | |
| </DL> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <A NAME="method_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Method Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="setKey(java.lang.String)"><!-- --></A><H3> | |
| setKey</H3> | |
| <PRE> | |
| public void <B>setKey</B>(java.lang.String key)</PRE> | |
| <DL> | |
| <DD>Mutators | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setClass(java.lang.Class)"><!-- --></A><H3> | |
| setClass</H3> | |
| <PRE> | |
| public void <B>setClass</B>(java.lang.Class clazz)</PRE> | |
| <DL> | |
| <DD>Tries to create an instance of the specified Class, then looks for a | |
| configure(Map<String,Object>) method. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>clazz</CODE> - the java.lang.Class of the tool</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="restrictTo(java.lang.String)"><!-- --></A><H3> | |
| restrictTo</H3> | |
| <PRE> | |
| public void <B>restrictTo</B>(java.lang.String path)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - the full or partial request path restriction of the tool</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setSkipSetters(boolean)"><!-- --></A><H3> | |
| setSkipSetters</H3> | |
| <PRE> | |
| public void <B>setSkipSetters</B>(boolean cfgOnly)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addProperties(java.util.Map)"><!-- --></A><H3> | |
| addProperties</H3> | |
| <PRE> | |
| public void <B>addProperties</B>(java.util.Map<java.lang.String,java.lang.Object> parentProps)</PRE> | |
| <DL> | |
| <DD>Adds a map of properties from a parent scope to the properties | |
| for this tool. Only new properties will be added; any that | |
| are already set for this tool will be ignored. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="putProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
| putProperty</H3> | |
| <PRE> | |
| public java.lang.Object <B>putProperty</B>(java.lang.String name, | |
| java.lang.Object value)</PRE> | |
| <DL> | |
| <DD>Puts a new property for this tool. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getProps()"><!-- --></A><H3> | |
| getProps</H3> | |
| <PRE> | |
| protected java.util.Map<java.lang.String,java.lang.Object> <B>getProps</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getKey()"><!-- --></A><H3> | |
| getKey</H3> | |
| <PRE> | |
| public java.lang.String <B>getKey</B>()</PRE> | |
| <DL> | |
| <DD>Accessors | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getClassname()"><!-- --></A><H3> | |
| getClassname</H3> | |
| <PRE> | |
| public java.lang.String <B>getClassname</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getToolClass()"><!-- --></A><H3> | |
| getToolClass</H3> | |
| <PRE> | |
| public java.lang.Class <B>getToolClass</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getProperties()"><!-- --></A><H3> | |
| getProperties</H3> | |
| <PRE> | |
| public java.util.Map<java.lang.String,java.lang.Object> <B>getProperties</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="hasConfigure()"><!-- --></A><H3> | |
| hasConfigure</H3> | |
| <PRE> | |
| public boolean <B>hasConfigure</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isSkipSetters()"><!-- --></A><H3> | |
| isSkipSetters</H3> | |
| <PRE> | |
| public boolean <B>isSkipSetters</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="hasPermission(java.lang.String)"><!-- --></A><H3> | |
| hasPermission</H3> | |
| <PRE> | |
| public boolean <B>hasPermission</B>(java.lang.String path)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - the path of a template requesting this tool | |
| <DT><B>Returns:</B><DD><code>true</code> if the specified | |
| request path matches the restrictions of this tool. | |
| If there is no request path restriction for this tool, | |
| it will always return <code>true</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="create(java.util.Map)"><!-- --></A><H3> | |
| create</H3> | |
| <PRE> | |
| public java.lang.Object <B>create</B>(java.util.Map<java.lang.String,java.lang.Object> dynamicProperties)</PRE> | |
| <DL> | |
| <DD>Returns a new instance of the tool. If the tool | |
| has an configure(Map) method, the new instance | |
| will be initialized using the given properties combined with | |
| whatever "constant" properties have been put into this | |
| ToolInfo. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="configure(java.lang.Object, java.util.Map)"><!-- --></A><H3> | |
| configure</H3> | |
| <PRE> | |
| protected void <B>configure</B>(java.lang.Object tool, | |
| java.util.Map<java.lang.String,java.lang.Object> configuration)</PRE> | |
| <DL> | |
| <DD>Actually performs configuration of the newly instantiated tool | |
| using the combined final set of configuration properties. First, | |
| if the class lacks the <A HREF="../../../../org/apache/velocity/tools/config/SkipSetters.html" title="annotation in org.apache.velocity.tools.config"><CODE>SkipSetters</CODE></A> annotation, then any | |
| specific setters matching the configuration keys are called, then | |
| the general configure(Map) method (if any) is called. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getConfigure()"><!-- --></A><H3> | |
| getConfigure</H3> | |
| <PRE> | |
| protected java.lang.reflect.Method <B>getConfigure</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="newInstance()"><!-- --></A><H3> | |
| newInstance</H3> | |
| <PRE> | |
| protected java.lang.Object <B>newInstance</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="invoke(java.lang.reflect.Method, java.lang.Object, java.lang.Object)"><!-- --></A><H3> | |
| invoke</H3> | |
| <PRE> | |
| protected void <B>invoke</B>(java.lang.reflect.Method method, | |
| java.lang.Object tool, | |
| java.lang.Object param)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setProperty(java.lang.Object, java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
| setProperty</H3> | |
| <PRE> | |
| protected void <B>setProperty</B>(java.lang.Object tool, | |
| java.lang.String name, | |
| java.lang.Object value) | |
| throws java.lang.Exception</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.lang.Exception</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="combine(java.util.Map...)"><!-- --></A><H3> | |
| combine</H3> | |
| <PRE> | |
| protected java.util.Map<java.lang.String,java.lang.Object> <B>combine</B>(java.util.Map<java.lang.String,java.lang.Object>... maps)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <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/ToolContext.html" title="class in org.apache.velocity.tools"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/velocity/tools/ToolInfo.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ToolInfo.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> |