📄 omtool.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc on Fri Dec 06 19:57:07 CET 2002 --><TITLE>jakarta-turbine-2 2.2 API: Class OMTool</TITLE><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"></HEAD><BODY BGCOLOR="white"><!-- ========== START OF NAVBAR ========== --><A NAME="navbar_top"><!-- --></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_top_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <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="class-use/OMTool.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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"> PREV CLASS NEXT CLASS</FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="OMTool.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | 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><!-- =========== END OF NAVBAR =========== --><HR><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">org.apache.turbine.om</FONT><BR>Class OMTool</H2><PRE>java.lang.Object | +--<B>org.apache.turbine.om.OMTool</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/turbine/services/pull/ApplicationTool.html">ApplicationTool</A>, <A HREF="../../../../org/apache/turbine/util/pool/Recyclable.html">Recyclable</A></DD></DL><HR><DL><DT>public class <B>OMTool</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/apache/turbine/services/pull/ApplicationTool.html">ApplicationTool</A>, <A HREF="../../../../org/apache/turbine/util/pool/Recyclable.html">Recyclable</A></DL><P>A Pull tool to make om objects available to a template<P><DL><DT><B>Version: </B><DD>$Id: OMTool.java,v 1.2 2002/07/11 14:28:45 mpoeschl Exp $</DD><DT><B>Author: </B><DD><a href="mailto:jmcnally@collab.net">John D. McNally</a></DD></DL><HR><P><!-- ======== INNER CLASS SUMMARY ======== --><!-- =========== FIELD SUMMARY =========== --><!-- ======== CONSTRUCTOR SUMMARY ======== --><A NAME="constructor_summary"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=2><FONT SIZE="+2"><B>Constructor Summary</B></FONT></TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../org/apache/turbine/om/OMTool.html#OMTool()">OMTool</A></B>()</CODE><BR> </TD></TR></TABLE> <!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=2><FONT SIZE="+2"><B>Method Summary</B></FONT></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/turbine/om/OMTool.html#dispose()">dispose</A></B>()</CODE><BR> Disposes the object after use.</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/turbine/om/OMTool.html#get(java.lang.String)">get</A></B>(java.lang.String omName)</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/turbine/om/OMTool.html#get(java.lang.String, java.lang.String)">get</A></B>(java.lang.String omName, 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/turbine/om/OMTool.html#getName()">getName</A></B>()</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/turbine/om/OMTool.html#init(java.lang.Object)">init</A></B>(java.lang.Object runData)</CODE><BR> Prepares tool for a single request</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/turbine/om/OMTool.html#isDisposed()">isDisposed</A></B>()</CODE><BR> Checks whether the recyclable has been disposed.</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/turbine/om/OMTool.html#recycle()">recycle</A></B>()</CODE><BR> Recycles the object for a new client.</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/turbine/om/OMTool.html#refresh()">refresh</A></B>()</CODE><BR> Implementation of ApplicationTool interface is not needed for this method as the tool is request scoped</TD></TR></TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TD><B>Methods inherited from class java.lang.Object</B></TD></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 =========== --><!-- ========= CONSTRUCTOR DETAIL ======== --><A NAME="constructor_detail"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2"><B>Constructor Detail</B></FONT></TD></TR></TABLE><A NAME="OMTool()"><!-- --></A><H3>OMTool</H3><PRE>public <B>OMTool</B>() throws java.lang.Exception</PRE><DL></DL><!-- ============ METHOD DETAIL ========== --><A NAME="method_detail"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2"><B>Method Detail</B></FONT></TD></TR></TABLE><A NAME="init(java.lang.Object)"><!-- --></A><H3>init</H3><PRE>public void <B>init</B>(java.lang.Object runData)</PRE><DL><DD>Prepares tool for a single request<DD><DL><DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/services/pull/ApplicationTool.html#init(java.lang.Object)">init</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/services/pull/ApplicationTool.html">ApplicationTool</A></CODE></DL></DD><DD>Following copied from interface: <CODE>org.apache.turbine.services.pull.ApplicationTool</CODE></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>data</CODE> - initialization data</DL></DD></DL><HR><A NAME="refresh()"><!-- --></A><H3>refresh</H3><PRE>public void <B>refresh</B>()</PRE><DL><DD>Implementation of ApplicationTool interface is not needed for this method as the tool is request scoped<DD><DL><DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/services/pull/ApplicationTool.html#refresh()">refresh</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/services/pull/ApplicationTool.html">ApplicationTool</A></CODE></DL></DD></DL><HR><A NAME="get(java.lang.String)"><!-- --></A><H3>get</H3><PRE>public java.lang.Object <B>get</B>(java.lang.String omName) throws java.lang.Exception</PRE><DL><DD><DL></DL></DD></DL><HR><A NAME="get(java.lang.String, java.lang.String)"><!-- --></A><H3>get</H3><PRE>public java.lang.Object <B>get</B>(java.lang.String omName, java.lang.String key) throws java.lang.Exception</PRE><DL><DD><DL></DL></DD></DL><HR><A NAME="getName()"><!-- --></A><H3>getName</H3><PRE>public java.lang.String <B>getName</B>()</PRE><DL><DD><DL></DL></DD></DL><HR><A NAME="recycle()"><!-- --></A><H3>recycle</H3><PRE>public void <B>recycle</B>()</PRE><DL><DD>Recycles the object for a new client. Recycle methods with parameters must be added to implementing object and they will be automatically called by pool implementations when the object is taken from the pool for a new client. The parameters must correspond to the parameters of the constructors of the object. For new objects, constructors can call their corresponding recycle methods whenever applicable. The recycle methods must call their super.<DD><DL><DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/util/pool/Recyclable.html#recycle()">recycle</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/util/pool/Recyclable.html">Recyclable</A></CODE></DL></DD></DL><HR><A NAME="dispose()"><!-- --></A><H3>dispose</H3><PRE>public void <B>dispose</B>()</PRE><DL><DD>Disposes the object after use. The method is called when the object is returned to its pool. The dispose method must call its super.<DD><DL><DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/util/pool/Recyclable.html#dispose()">dispose</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/util/pool/Recyclable.html">Recyclable</A></CODE></DL></DD></DL><HR><A NAME="isDisposed()"><!-- --></A><H3>isDisposed</H3><PRE>public boolean <B>isDisposed</B>()</PRE><DL><DD>Checks whether the recyclable has been disposed.<DD><DL><DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/util/pool/Recyclable.html#isDisposed()">isDisposed</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/util/pool/Recyclable.html">Recyclable</A></CODE></DL></DD><DD><DL><DT><B>Returns:</B><DD>true, if the recyclable is disposed.</DL></DD></DL><!-- ========= END OF CLASS DATA ========= --><HR><!-- ========== START OF NAVBAR ========== --><A NAME="navbar_bottom"><!-- --></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_bottom_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <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="class-use/OMTool.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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"> PREV CLASS NEXT CLASS</FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="OMTool.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | 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><!-- =========== END OF NAVBAR =========== --><HR>Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.</BODY></HTML>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -