blob: 52a7e96a7055c1c73d2138794417f239865e17e5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Fri Aug 22 03:44:00 EDT 2003 -->
<TITLE>
ReloadableDefinitionsFactory (Apache Struts API Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.struts.tiles.definition.ReloadableDefinitionsFactory,ReloadableDefinitionsFactory class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="ReloadableDefinitionsFactory (Apache Struts API Documentation)";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReloadableDefinitionsFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/struts/tiles/definition/ComponentDefinitionsFactoryWrapper.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.ServletPropertiesMap.html"><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> &nbsp;
&nbsp;<A HREF="ReloadableDefinitionsFactory.html" TARGET="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.struts.tiles.definition</FONT>
<BR>
Class ReloadableDefinitionsFactory</H2>
<PRE>
java.lang.Object
|
+--<B>org.apache.struts.tiles.definition.ReloadableDefinitionsFactory</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A>, java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT>public class <B>ReloadableDefinitionsFactory</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A></DL>
<P>
A reloadable factory.
This factory is the main entrance to any factory implementation. It takes in
charge real implementation instance, and allows reloading by creating a new
instance.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.1</DD>
<DT><B>Version:</B></DT>
<DD>$Revision: 1.1 $ $Date$</DD>
<DT><B>Author:</B></DT>
<DD>Cedric Dumoulin</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html" TARGET="org.apache.struts.tiles.definition.ReloadableDefinitionsFactory">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) &nbsp;class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.ServletPropertiesMap.html">ReloadableDefinitionsFactory.ServletPropertiesMap</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inner class.</TD>
</TR>
</TABLE>
&nbsp;
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.html#DEFINITIONS_FACTORY_CLASSNAME">DEFINITIONS_FACTORY_CLASSNAME</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of init property carrying factory class name</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.html#factory">factory</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The real factory instance</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.util.Map</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.html#properties">properties</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initialization parameters</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== 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/struts/tiles/definition/ReloadableDefinitionsFactory.html#ReloadableDefinitionsFactory(javax.servlet.ServletContext, java.util.Map)">ReloadableDefinitionsFactory</A></B>(javax.servlet.ServletContext&nbsp;servletContext,
java.util.Map&nbsp;properties)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.html#ReloadableDefinitionsFactory(javax.servlet.ServletContext, javax.servlet.ServletConfig)">ReloadableDefinitionsFactory</A></B>(javax.servlet.ServletContext&nbsp;servletContext,
javax.servlet.ServletConfig&nbsp;servletConfig)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;<A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.html#createDefaultFactory(javax.servlet.ServletContext, java.util.Map)">createDefaultFactory</A></B>(javax.servlet.ServletContext&nbsp;servletContext,
java.util.Map&nbsp;properties)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create default Definition factory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.html#createFactory(javax.servlet.ServletContext, java.util.Map)">createFactory</A></B>(javax.servlet.ServletContext&nbsp;servletContext,
java.util.Map&nbsp;properties)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create Definition factory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.html#createFactoryFromClassname(javax.servlet.ServletContext, java.util.Map, java.lang.String)">createFactoryFromClassname</A></B>(javax.servlet.ServletContext&nbsp;servletContext,
java.util.Map&nbsp;properties,
java.lang.String&nbsp;classname)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create Definition factory from provided classname.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/struts/tiles/ComponentDefinition.html">ComponentDefinition</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.html#getDefinition(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletContext)">getDefinition</A></B>(java.lang.String&nbsp;definitionName,
javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletContext&nbsp;servletContext)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a definition by its name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.html#getFactory()">getFactory</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get underlying factory instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.html#initFactory(javax.servlet.ServletContext, java.util.Map)">initFactory</A></B>(javax.servlet.ServletContext&nbsp;servletContext,
java.util.Map&nbsp;properties)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Init factory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.html#reload(javax.servlet.ServletContext)">reload</A></B>(javax.servlet.ServletContext&nbsp;servletContext)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reload underlying factory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.html#toString()">toString</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return String representation.</TD>
</TR>
</TABLE>
&nbsp;<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, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="factory"><!-- --></A><H3>
factory</H3>
<PRE>
protected <A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A> <B>factory</B></PRE>
<DL>
<DD>The real factory instance
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="properties"><!-- --></A><H3>
properties</H3>
<PRE>
protected java.util.Map <B>properties</B></PRE>
<DL>
<DD>Initialization parameters
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="DEFINITIONS_FACTORY_CLASSNAME"><!-- --></A><H3>
DEFINITIONS_FACTORY_CLASSNAME</H3>
<PRE>
public static final java.lang.String <B>DEFINITIONS_FACTORY_CLASSNAME</B></PRE>
<DL>
<DD>Name of init property carrying factory class name
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.struts.tiles.definition.ReloadableDefinitionsFactory.DEFINITIONS_FACTORY_CLASSNAME">Constant Field Values</A></DL>
</DL>
<!-- ========= 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="ReloadableDefinitionsFactory(javax.servlet.ServletContext, javax.servlet.ServletConfig)"><!-- --></A><H3>
ReloadableDefinitionsFactory</H3>
<PRE>
public <B>ReloadableDefinitionsFactory</B>(javax.servlet.ServletContext&nbsp;servletContext,
javax.servlet.ServletConfig&nbsp;servletConfig)
throws <A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE>
<DL>
<DD>Constructor.
Create a factory according to servlet settings.
<P>
<DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - Our servlet context.<DD><CODE>servletConfig</CODE> - Our servlet config.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - If factory creation fail.</DL>
<HR>
<A NAME="ReloadableDefinitionsFactory(javax.servlet.ServletContext, java.util.Map)"><!-- --></A><H3>
ReloadableDefinitionsFactory</H3>
<PRE>
public <B>ReloadableDefinitionsFactory</B>(javax.servlet.ServletContext&nbsp;servletContext,
java.util.Map&nbsp;properties)
throws <A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE>
<DL>
<DD>Constructor.
Create a factory according to servlet settings.
<P>
<DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - Our servlet context.<DD><CODE>properties</CODE> - Map containing all properties.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - If factory creation fail.</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="createFactoryFromClassname(javax.servlet.ServletContext, java.util.Map, java.lang.String)"><!-- --></A><H3>
createFactoryFromClassname</H3>
<PRE>
public <A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A> <B>createFactoryFromClassname</B>(javax.servlet.ServletContext&nbsp;servletContext,
java.util.Map&nbsp;properties,
java.lang.String&nbsp;classname)
throws <A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE>
<DL>
<DD>Create Definition factory from provided classname.
If a factory class name is provided, a factory of this class is created. Otherwise,
a default factory is created.
Factory must have a constructor taking ServletContext and Map as parameter.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>classname</CODE> - Class name of the factory to create.<DD><CODE>servletContext</CODE> - Servlet Context passed to newly created factory.<DD><CODE>properties</CODE> - Map of name/property passed to newly created factory.
<DT><B>Returns:</B><DD>newly created factory.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - If an error occur while initializing factory</DL>
</DD>
</DL>
<HR>
<A NAME="createDefaultFactory(javax.servlet.ServletContext, java.util.Map)"><!-- --></A><H3>
createDefaultFactory</H3>
<PRE>
public <A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A> <B>createDefaultFactory</B>(javax.servlet.ServletContext&nbsp;servletContext,
java.util.Map&nbsp;properties)
throws <A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE>
<DL>
<DD>Create default Definition factory.
Factory must have a constructor taking ServletContext and Map as parameter.
In this implementation, default factory is of class I18nFactorySet
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - Servlet Context passed to newly created factory.<DD><CODE>properties</CODE> - Map of name/property passed to newly created factory.
<DT><B>Returns:</B><DD>newly created factory.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - If an error occur while initializing factory</DL>
</DD>
</DL>
<HR>
<A NAME="createFactory(javax.servlet.ServletContext, java.util.Map)"><!-- --></A><H3>
createFactory</H3>
<PRE>
public <A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A> <B>createFactory</B>(javax.servlet.ServletContext&nbsp;servletContext,
java.util.Map&nbsp;properties)
throws <A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE>
<DL>
<DD>Create Definition factory.
Convenience method. ServletConfig is wrapped into a Map allowing retrieval
of init parameters. Factory classname is also retrieved, as well as debug level.
Finally, approriate createDefinitionsFactory() is called.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - Servlet Context passed to newly created factory.<DD><CODE>properties</CODE> - Map containing all properties.
<DD><CODE><A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getDefinition(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletContext)"><!-- --></A><H3>
getDefinition</H3>
<PRE>
public <A HREF="../../../../../org/apache/struts/tiles/ComponentDefinition.html">ComponentDefinition</A> <B>getDefinition</B>(java.lang.String&nbsp;definitionName,
javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletContext&nbsp;servletContext)
throws <A HREF="../../../../../org/apache/struts/tiles/FactoryNotFoundException.html">FactoryNotFoundException</A>,
<A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE>
<DL>
<DD>Get a definition by its name.
Call appropriate method on underlying factory instance.
Throw appropriate exception if definition or definition factory is not found.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html#getDefinition(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletContext)">getDefinition</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>definitionName</CODE> - Name of requested definition.<DD><CODE>request</CODE> - Current servlet request.<DD><CODE>servletContext</CODE> - Current servlet context.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/struts/tiles/FactoryNotFoundException.html">FactoryNotFoundException</A></CODE> - Can't find definition factory.
<DD><CODE><A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - General error in factory while getting definition.</DL>
</DD>
</DL>
<HR>
<A NAME="reload(javax.servlet.ServletContext)"><!-- --></A><H3>
reload</H3>
<PRE>
public void <B>reload</B>(javax.servlet.ServletContext&nbsp;servletContext)
throws <A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE>
<DL>
<DD>Reload underlying factory.
Reload is done by creating a new factory instance, and replacing the old instance
with the new one.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - Current servlet context.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - If factory creation fails.</DL>
</DD>
</DL>
<HR>
<A NAME="getFactory()"><!-- --></A><H3>
getFactory</H3>
<PRE>
public <A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A> <B>getFactory</B>()</PRE>
<DL>
<DD>Get underlying factory instance.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>ComponentDefinitionsFactory</DL>
</DD>
</DL>
<HR>
<A NAME="initFactory(javax.servlet.ServletContext, java.util.Map)"><!-- --></A><H3>
initFactory</H3>
<PRE>
public void <B>initFactory</B>(javax.servlet.ServletContext&nbsp;servletContext,
java.util.Map&nbsp;properties)
throws <A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE>
<DL>
<DD>Init factory.
This method is required by interface ComponentDefinitionsFactory. It is
not used in this implementation, as it manages itself the underlying creation
and initialization.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html#initFactory(javax.servlet.ServletContext, java.util.Map)">initFactory</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/struts/tiles/ComponentDefinitionsFactory.html">ComponentDefinitionsFactory</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - Servlet Context passed to newly created factory.<DD><CODE>properties</CODE> - Map of name/property passed to newly created factory.
Map can contain more properties than requested.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - An error occur during initialization.</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>Return String representation.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>String representation.</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=3 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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReloadableDefinitionsFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/struts/tiles/definition/ComponentDefinitionsFactoryWrapper.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/struts/tiles/definition/ReloadableDefinitionsFactory.ServletPropertiesMap.html"><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> &nbsp;
&nbsp;<A HREF="ReloadableDefinitionsFactory.html" TARGET="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
Copyright © 2000-2003 - Apache Software Foundation
</BODY>
</HTML>