1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
5
<!-- Generated by javadoc on Fri Jun 15 16:53:37 PDT 2001 -->
7
Apache Struts API Documentation: Class MessageResourcesFactory
9
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
11
<BODY BGCOLOR="white">
13
<!-- ========== START OF NAVBAR ========== -->
14
<A NAME="navbar_top"><!-- --></A>
15
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
17
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
18
<A NAME="navbar_top_firstrow"><!-- --></A>
19
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
20
<TR ALIGN="center" VALIGN="top">
21
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
22
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
23
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
24
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
25
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
26
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
27
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
31
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
37
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
38
<A HREF="../../../../org/apache/struts/util/MessageResources.html"><B>PREV CLASS</B></A>
39
<A HREF="../../../../org/apache/struts/util/PropertyMessageResources.html"><B>NEXT CLASS</B></A></FONT></TD>
40
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
41
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
42
<A HREF="MessageResourcesFactory.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
45
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
46
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
47
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
48
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
51
<!-- =========== END OF NAVBAR =========== -->
54
<!-- ======== START OF CLASS DATA ======== -->
57
org.apache.struts.util</FONT>
59
Class MessageResourcesFactory</H2>
63
+--<B>org.apache.struts.util.MessageResourcesFactory</B>
66
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
69
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/struts/util/PropertyMessageResourcesFactory.html">PropertyMessageResourcesFactory</A></DD>
73
<DT>public abstract class <B>MessageResourcesFactory</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL>
76
Factory for <code>MessageResources</code> instances. The general usage
77
pattern for this class is:
79
<li>Call <code>MessageResourcesFactory().createFactory()</code> to retrieve
80
a <code>MessageResourcesFactory</code> instance.</li>
81
<li>Set properties as required to configure this factory instance to create
82
<code>MessageResources</code> instances with desired
84
<li>Call the <code>createResources()</code> method of the factory to
85
retrieve a newly instantiated <code>MessageResources</code>
90
<DT><B>Version: </B><DD>$Revision: 1.1 $ $Date: 2001/09/17 20:13:29 $</DD>
91
<DT><B>Author: </B><DD>Craig R. McClanahan</DD>
92
<DT><B>See Also: </B><DD><A HREF="../../../../serialized-form.html#org.apache.struts.util.MessageResourcesFactory">Serialized Form</A></DL>
96
<!-- ======== INNER CLASS SUMMARY ======== -->
99
<!-- =========== FIELD SUMMARY =========== -->
101
<A NAME="field_summary"><!-- --></A>
102
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
103
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
104
<TD COLSPAN=2><FONT SIZE="+2">
105
<B>Field Summary</B></FONT></TD>
107
<TR BGCOLOR="white" CLASS="TableRowColor">
108
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
109
<CODE>protected static java.lang.Class</CODE></FONT></TD>
110
<TD><CODE><B><A HREF="../../../../org/apache/struts/util/MessageResourcesFactory.html#clazz">clazz</A></B></CODE>
113
The Java class to be used for
114
<code>MessageResourcesFactory</code> instances.</TD>
116
<TR BGCOLOR="white" CLASS="TableRowColor">
117
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
118
<CODE>protected static java.lang.String</CODE></FONT></TD>
119
<TD><CODE><B><A HREF="../../../../org/apache/struts/util/MessageResourcesFactory.html#factoryClass">factoryClass</A></B></CODE>
122
The fully qualified class name to be used for
123
<code>MessageResourcesFactory</code> instances.</TD>
125
<TR BGCOLOR="white" CLASS="TableRowColor">
126
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
127
<CODE>protected boolean</CODE></FONT></TD>
128
<TD><CODE><B><A HREF="../../../../org/apache/struts/util/MessageResourcesFactory.html#returnNull">returnNull</A></B></CODE>
131
The "return null" property value to which newly created
132
MessageResourcess should be initialized.</TD>
136
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
138
<A NAME="constructor_summary"><!-- --></A>
139
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
140
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
141
<TD COLSPAN=2><FONT SIZE="+2">
142
<B>Constructor Summary</B></FONT></TD>
144
<TR BGCOLOR="white" CLASS="TableRowColor">
145
<TD><CODE><B><A HREF="../../../../org/apache/struts/util/MessageResourcesFactory.html#MessageResourcesFactory()">MessageResourcesFactory</A></B>()</CODE>
148
</TD>
152
<!-- ========== METHOD SUMMARY =========== -->
154
<A NAME="method_summary"><!-- --></A>
155
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
156
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
157
<TD COLSPAN=2><FONT SIZE="+2">
158
<B>Method Summary</B></FONT></TD>
160
<TR BGCOLOR="white" CLASS="TableRowColor">
161
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162
<CODE>static <A HREF="../../../../org/apache/struts/util/MessageResourcesFactory.html">MessageResourcesFactory</A></CODE></FONT></TD>
163
<TD><CODE><B><A HREF="../../../../org/apache/struts/util/MessageResourcesFactory.html#createFactory()">createFactory</A></B>()</CODE>
166
Create and return a <code>MessageResourcesFactory</code> instance of the
167
appropriate class, which can be used to create customized
168
<code>MessageResources</code> instances.</TD>
170
<TR BGCOLOR="white" CLASS="TableRowColor">
171
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172
<CODE>abstract <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A></CODE></FONT></TD>
173
<TD><CODE><B><A HREF="../../../../org/apache/struts/util/MessageResourcesFactory.html#createResources(java.lang.String)">createResources</A></B>(java.lang.String config)</CODE>
176
Create and return a newly instansiated <code>MessageResources</code>.</TD>
178
<TR BGCOLOR="white" CLASS="TableRowColor">
179
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180
<CODE>static java.lang.String</CODE></FONT></TD>
181
<TD><CODE><B><A HREF="../../../../org/apache/struts/util/MessageResourcesFactory.html#getFactoryClass()">getFactoryClass</A></B>()</CODE>
184
</TD>
186
<TR BGCOLOR="white" CLASS="TableRowColor">
187
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188
<CODE> boolean</CODE></FONT></TD>
189
<TD><CODE><B><A HREF="../../../../org/apache/struts/util/MessageResourcesFactory.html#getReturnNull()">getReturnNull</A></B>()</CODE>
192
</TD>
194
<TR BGCOLOR="white" CLASS="TableRowColor">
195
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196
<CODE>static void</CODE></FONT></TD>
197
<TD><CODE><B><A HREF="../../../../org/apache/struts/util/MessageResourcesFactory.html#setFactoryClass(java.lang.String)">setFactoryClass</A></B>(java.lang.String factoryClass)</CODE>
200
</TD>
202
<TR BGCOLOR="white" CLASS="TableRowColor">
203
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204
<CODE> void</CODE></FONT></TD>
205
<TD><CODE><B><A HREF="../../../../org/apache/struts/util/MessageResourcesFactory.html#setReturnNull(boolean)">setReturnNull</A></B>(boolean returnNull)</CODE>
208
</TD>
211
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
212
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
213
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
214
<TD><B>Methods inherited from class java.lang.Object</B></TD>
216
<TR BGCOLOR="white" CLASS="TableRowColor">
217
<TD><CODE><clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait</CODE></TD>
223
<!-- ============ FIELD DETAIL =========== -->
225
<A NAME="field_detail"><!-- --></A>
226
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
227
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
228
<TD COLSPAN=1><FONT SIZE="+2">
229
<B>Field Detail</B></FONT></TD>
233
<A NAME="returnNull"><!-- --></A><H3>
236
protected boolean <B>returnNull</B></PRE>
238
<DD>The "return null" property value to which newly created
239
MessageResourcess should be initialized.</DL>
242
<A NAME="clazz"><!-- --></A><H3>
245
protected static transient java.lang.Class <B>clazz</B></PRE>
247
<DD>The Java class to be used for
248
<code>MessageResourcesFactory</code> instances.</DL>
251
<A NAME="factoryClass"><!-- --></A><H3>
254
protected static java.lang.String <B>factoryClass</B></PRE>
256
<DD>The fully qualified class name to be used for
257
<code>MessageResourcesFactory</code> instances.</DL>
259
<!-- ========= CONSTRUCTOR DETAIL ======== -->
261
<A NAME="constructor_detail"><!-- --></A>
262
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
263
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
264
<TD COLSPAN=1><FONT SIZE="+2">
265
<B>Constructor Detail</B></FONT></TD>
269
<A NAME="MessageResourcesFactory()"><!-- --></A><H3>
270
MessageResourcesFactory</H3>
272
public <B>MessageResourcesFactory</B>()</PRE>
276
<!-- ============ METHOD DETAIL ========== -->
278
<A NAME="method_detail"><!-- --></A>
279
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
280
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
281
<TD COLSPAN=1><FONT SIZE="+2">
282
<B>Method Detail</B></FONT></TD>
286
<A NAME="getReturnNull()"><!-- --></A><H3>
289
public boolean <B>getReturnNull</B>()</PRE>
297
<A NAME="setReturnNull(boolean)"><!-- --></A><H3>
300
public void <B>setReturnNull</B>(boolean returnNull)</PRE>
308
<A NAME="createResources(java.lang.String)"><!-- --></A><H3>
311
public abstract <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A> <B>createResources</B>(java.lang.String config)</PRE>
313
<DD>Create and return a newly instansiated <code>MessageResources</code>.
314
This method must be implemented by concrete subclasses.<DD><DL>
318
<DT><B>Parameters:</B><DD><CODE>config</CODE> - Configuration parameter(s) for the requested bundle</DL>
323
<A NAME="getFactoryClass()"><!-- --></A><H3>
326
public static java.lang.String <B>getFactoryClass</B>()</PRE>
334
<A NAME="setFactoryClass(java.lang.String)"><!-- --></A><H3>
337
public static void <B>setFactoryClass</B>(java.lang.String factoryClass)</PRE>
345
<A NAME="createFactory()"><!-- --></A><H3>
348
public static <A HREF="../../../../org/apache/struts/util/MessageResourcesFactory.html">MessageResourcesFactory</A> <B>createFactory</B>()</PRE>
350
<DD>Create and return a <code>MessageResourcesFactory</code> instance of the
351
appropriate class, which can be used to create customized
352
<code>MessageResources</code> instances. If no such factory can be
353
created, return <code>null</code> instead.<DD><DL>
357
<!-- ========= END OF CLASS DATA ========= -->
360
<!-- ========== START OF NAVBAR ========== -->
361
<A NAME="navbar_bottom"><!-- --></A>
362
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
364
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
365
<A NAME="navbar_bottom_firstrow"><!-- --></A>
366
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
367
<TR ALIGN="center" VALIGN="top">
368
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
369
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
370
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
371
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
372
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
373
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
374
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
378
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
384
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
385
<A HREF="../../../../org/apache/struts/util/MessageResources.html"><B>PREV CLASS</B></A>
386
<A HREF="../../../../org/apache/struts/util/PropertyMessageResources.html"><B>NEXT CLASS</B></A></FONT></TD>
387
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
388
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
389
<A HREF="MessageResourcesFactory.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
392
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
393
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
394
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
395
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
398
<!-- =========== END OF NAVBAR =========== -->
401
Copyright � 2000-2001 - Apache Software Foundation