rleland 2002/10/16 20:20:31
Modified: src/share/org/apache/struts/util MessageResources.java
MessageResourcesFactory.java
Log:
Update missing JavaDocs
Revision Changes Path
1.15 +25 -6
jakarta-struts/src/share/org/apache/struts/util/MessageResources.java
Index: MessageResources.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/util/MessageResources.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- MessageResources.java 30 Jun 2002 03:38:30 -0000 1.14
+++ MessageResources.java 17 Oct 2002 03:20:31 -0000 1.15
@@ -110,6 +110,10 @@
*/
protected String config = null;
+ /**
+ * The configuration parameter used to initialize this MessageResources.
+ * @return parameter used to initialize this MessageResources
+ */
public String getConfig() {
return (this.config);
}
@@ -126,6 +130,10 @@
*/
protected MessageResourcesFactory factory = null;
+ /**
+ * The <code>MessageResourcesFactory</code> that created this instance.
+ * @return<code>MessageResourcesFactory</code> that created instance
+ */
public MessageResourcesFactory getFactory() {
return (this.factory);
}
@@ -139,15 +147,26 @@
/**
- * Should we return <code>null</code> instead of an error message string
- * if an unknown Locale or key is requested?
+ * Indicate is a <code>null</code> is returned instead of an error message
string
+ * when an unknown Locale or key is requested.
*/
protected boolean returnNull = false;
+ /**
+ * Indicates that a <code>null</code> is returned instead of an error message
string
+ * if an unknown Locale or key is requested.
+ * @return true if null is returned if unknown key or locale is requested
+ */
public boolean getReturnNull() {
return (this.returnNull);
}
+ /**
+ * Indicates that a <code>null</code> is returned instead of an error message
string
+ * if an unknown Locale or key is requested.
+ * @param returnNull true Indicates that a <code>null</code> is returned
+ * if an unknown Locale or key is requested.
+ */
public void setReturnNull(boolean returnNull) {
this.returnNull = returnNull;
}
1.8 +27 -4
jakarta-struts/src/share/org/apache/struts/util/MessageResourcesFactory.java
Index: MessageResourcesFactory.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/util/MessageResourcesFactory.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- MessageResourcesFactory.java 10 Mar 2002 01:23:30 -0000 1.7
+++ MessageResourcesFactory.java 17 Oct 2002 03:20:31 -0000 1.8
@@ -98,10 +98,21 @@
*/
protected boolean returnNull = true;
+ /**
+ * Get default value of the "returnNull" property used to initialize newly
created
+ * MessageResourcess.
+ * @return default value of the "returnNull" property newly created
+ * MessageResourcess are initialized to.
+ */
public boolean getReturnNull() {
return (this.returnNull);
}
+ /**
+ * Set the default value of the "returnNull" property newly created
+ * MessageResourcess are initialized to.
+ * @param returnNull default value of the "returnNull" MessageResourcess are
initialized to.
+ */
public void setReturnNull(boolean returnNull) {
this.returnNull = returnNull;
}
@@ -142,10 +153,22 @@
protected static String factoryClass =
"org.apache.struts.util.PropertyMessageResourcesFactory";
+ /**
+ * The fully qualified class name that is used for
+ * <code>MessageResourcesFactory</code> instances.
+ * @return class name that is used for
+ * <code>MessageResourcesFactory</code> instances
+ */
public static String getFactoryClass() {
return (MessageResourcesFactory.factoryClass);
}
+ /**
+ * Set the fully qualified class name that is used for
+ * <code>MessageResourcesFactory</code> instances.
+ * @param factoryClass name that is used for
+ * <code>MessageResourcesFactory</code> instances
+ */
public static void setFactoryClass(String factoryClass) {
MessageResourcesFactory.factoryClass = factoryClass;
MessageResourcesFactory.clazz = null;
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
