Author: dflorey
Date: Sat Feb 19 08:38:47 2005
New Revision: 154420
URL: http://svn.apache.org/viewcvs?view=rev&rev=154420
Log:
Added some javadocs
Modified:
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedBundle.java
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedError.java
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedException.java
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedRuntimeException.java
Modified:
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedBundle.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedBundle.java?view=diff&r1=154419&r2=154420
==============================================================================
---
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedBundle.java
(original)
+++
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedBundle.java
Sat Feb 19 08:38:47 2005
@@ -32,8 +32,8 @@
* The <code>LocalizedBundle</code> class represents a bundle of localized
messages that
* belong together.
* The <code>LocalizedBundle</code> class itself contains the message id and
the arguments
- * that might be used to include dynamic values into the message text and
knows nothing
- *
+ * that might be used to include dynamic values into the message text.
+ *
*/
public class LocalizedBundle implements Serializable {
public final static String ID = "id";
@@ -44,8 +44,7 @@
/**
* @param messageId The messageId refers the corresponding bundle in the
file containing
- * the localized messages. The format of the message file depends on the
implementation of the
- * MessageManager.
+ * the localized messages.
*/
public LocalizedBundle(String messageId) {
this.id = messageId;
@@ -54,9 +53,8 @@
/**
* @param messageId The messageId refers the corresponding bundle in the
file containing
- * the localized messages. The format of the message file depends on the
implementation of the
- * MessageManager.
- * @param arguments An array of objects containing argument for the
messages. These arguments
+ * the localized messages.
+ * @param arguments An array of objects containing arguments for the
messages. These arguments
* are used to insert dynamic values into the localized messages.
*/
public LocalizedBundle(String messageId, Object[] arguments) {
Modified:
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedError.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedError.java?view=diff&r1=154419&r2=154420
==============================================================================
---
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedError.java
(original)
+++
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedError.java
Sat Feb 19 08:38:47 2005
@@ -27,14 +27,27 @@
import org.apache.commons.i18n.bundles.ErrorBundle;
+/**
+ * The <code>LocalizedError</code> class is the base class for all errors
+ * that provide locaized error informations. This class should be subclassed
+ * in order to provide specific errors capable of localization support.
+ *
+ */
public class LocalizedError extends Error {
private ErrorBundle errorMessage;
+ /**
+ * @param errorMessage The error message contains a detailed localized
description of this error
+ * @param throwable The <code>Throwable</code> that caused this error
+ */
public LocalizedError(ErrorBundle errorMessage, Throwable throwable) {
super(errorMessage.getSummary(Locale.getDefault(),
throwable.getMessage()), throwable);
this.errorMessage = errorMessage;
}
+ /**
+ * @param errorMessage The error message contains a detailed localized
description of this error
+ */
public LocalizedError(ErrorBundle errorMessage) {
super(errorMessage.getSummary(
Locale.getDefault(),
@@ -44,6 +57,10 @@
this.errorMessage = errorMessage;
}
+
+ /**
+ * @return the detailed error message that describes this error
+ */
public ErrorBundle getErrorMessage() {
return errorMessage;
}
Modified:
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedException.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedException.java?view=diff&r1=154419&r2=154420
==============================================================================
---
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedException.java
(original)
+++
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedException.java
Sat Feb 19 08:38:47 2005
@@ -27,14 +27,26 @@
import org.apache.commons.i18n.bundles.ErrorBundle;
+/**
+ * The <code>LocalizedException</code> class is the base class for all
exceptions
+ * that provide locaized error informations.
+ *
+ */
public class LocalizedException extends Exception {
private ErrorBundle errorMessage;
+ /**
+ * @param errorMessage The error message contains a detailed localized
description of the error that caused the exception
+ * @param throwable The <code>Throwable</code> that caused this exception
+ */
public LocalizedException(ErrorBundle errorMessage, Throwable throwable) {
super(errorMessage.getSummary(Locale.getDefault(),
throwable.getMessage()), throwable);
this.errorMessage = errorMessage;
}
+ /**
+ * @param errorMessage The error message contains a detailed localized
description of the error that caused the exception
+ */
public LocalizedException(ErrorBundle errorMessage) {
super(errorMessage.getSummary(
Locale.getDefault(),
@@ -44,6 +56,9 @@
this.errorMessage = errorMessage;
}
+ /**
+ * @return the detailed error message that describes this exception
+ */
public ErrorBundle getErrorMessage() {
return errorMessage;
}
Modified:
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedRuntimeException.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedRuntimeException.java?view=diff&r1=154419&r2=154420
==============================================================================
---
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedRuntimeException.java
(original)
+++
jakarta/commons/sandbox/i18n/trunk/src/java/org/apache/commons/i18n/LocalizedRuntimeException.java
Sat Feb 19 08:38:47 2005
@@ -27,14 +27,25 @@
import org.apache.commons.i18n.bundles.ErrorBundle;
-public class LocalizedRuntimeException extends RuntimeException {
+/**
+ * The <code>LocalizedRuntimeException</code> class is the base class for all
runtime exceptions
+ * that provide locaized error informations.
+ *
+ */public class LocalizedRuntimeException extends RuntimeException {
private ErrorBundle errorMessage;
+ /**
+ * @param errorMessage The error message contains a detailed localized
description of the error that caused the exception
+ * @param throwable The <code>Throwable</code> that caused this exception
+ */
public LocalizedRuntimeException(ErrorBundle errorMessage, Throwable
throwable) {
super(errorMessage.getSummary(Locale.getDefault(),
throwable.getMessage()), throwable);
this.errorMessage = errorMessage;
}
+ /**
+ * @param errorMessage The error message contains a detailed localized
description of the error that caused the exception
+ */
public LocalizedRuntimeException(ErrorBundle errorMessage) {
super(errorMessage.getSummary(
Locale.getDefault(),
@@ -44,6 +55,9 @@
this.errorMessage = errorMessage;
}
+ /**
+ * @return the detailed error message that describes this exception
+ */
public ErrorBundle getErrorMessage() {
return errorMessage;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
