Author: jkaputin
Date: Sat Oct 8 05:31:49 2005
New Revision: 307289
URL: http://svn.apache.org/viewcvs?rev=307289&view=rev
Log:
Modified the Javadoc comments.
Modified:
incubator/woden/java/src/org/apache/woden/ErrorHandler.java
incubator/woden/java/src/org/apache/woden/ErrorInfo.java
incubator/woden/java/src/org/apache/woden/internal/ErrorInfoImpl.java
incubator/woden/java/src/org/apache/woden/internal/ErrorReporter.java
Modified: incubator/woden/java/src/org/apache/woden/ErrorHandler.java
URL:
http://svn.apache.org/viewcvs/incubator/woden/java/src/org/apache/woden/ErrorHandler.java?rev=307289&r1=307288&r2=307289&view=diff
==============================================================================
--- incubator/woden/java/src/org/apache/woden/ErrorHandler.java (original)
+++ incubator/woden/java/src/org/apache/woden/ErrorHandler.java Sat Oct 8
05:31:49 2005
@@ -16,11 +16,12 @@
package org.apache.woden;
/**
- * This interface declares separate operations for handling three types
+ * This interface declares operations for handling three types
* of errors; warnings, errors and fatal errors. Implementations should define
* behaviour for these types of errors appropriate to their requirements.
- * For example, errors may be reported immediately via the system output stream
- * or they may be cached for further processing by the invoking application.
+ * For example, errors may be reported immediately by printing to the system
+ * output stream or they may be cached for further processing by the invoking
+ * application.
*
* This is based on the Xerces error reporter.
*
Modified: incubator/woden/java/src/org/apache/woden/ErrorInfo.java
URL:
http://svn.apache.org/viewcvs/incubator/woden/java/src/org/apache/woden/ErrorInfo.java?rev=307289&r1=307288&r2=307289&view=diff
==============================================================================
--- incubator/woden/java/src/org/apache/woden/ErrorInfo.java (original)
+++ incubator/woden/java/src/org/apache/woden/ErrorInfo.java Sat Oct 8
05:31:49 2005
@@ -16,10 +16,12 @@
package org.apache.woden;
/**
- * This interface presents the information required to handle all types
- * of errors (warning, error, fatal error) and provides a common reference
- * to them.
-
+ * This interface describes the three types of errors (warning, error
+ * and fatal error) that may be reported.
+ * Implementations may choose to override the java.lang.Object
+ * <code>toString()</code> method to concatenate this information into
+ * a single string for reporting purposes.
+ *
* @author kaputin
*/
public interface ErrorInfo {
Modified: incubator/woden/java/src/org/apache/woden/internal/ErrorInfoImpl.java
URL:
http://svn.apache.org/viewcvs/incubator/woden/java/src/org/apache/woden/internal/ErrorInfoImpl.java?rev=307289&r1=307288&r2=307289&view=diff
==============================================================================
--- incubator/woden/java/src/org/apache/woden/internal/ErrorInfoImpl.java
(original)
+++ incubator/woden/java/src/org/apache/woden/internal/ErrorInfoImpl.java Sat
Oct 8 05:31:49 2005
@@ -19,9 +19,9 @@
/**
* This class is a data object containing the information needed
- * for reporting warnings, errors and fatal errors. It includes a
- * convenience method to concatenate all of this information into
- * a single string.
+ * for reporting warnings, errors and fatal errors. It overrides
+ * the toString() method to concatenate this information into
+ * a single string for reporting purposes.
*
* @author [EMAIL PROTECTED]
*/
Modified: incubator/woden/java/src/org/apache/woden/internal/ErrorReporter.java
URL:
http://svn.apache.org/viewcvs/incubator/woden/java/src/org/apache/woden/internal/ErrorReporter.java?rev=307289&r1=307288&r2=307289&view=diff
==============================================================================
--- incubator/woden/java/src/org/apache/woden/internal/ErrorReporter.java
(original)
+++ incubator/woden/java/src/org/apache/woden/internal/ErrorReporter.java Sat
Oct 8 05:31:49 2005
@@ -25,21 +25,24 @@
/**
- * This class reports the errors (warnings, errors and fatal errors)
- * related to processing or validating the WSDL or parsing the XML.
- * That is, it reports WSDL and XML errors back to the user application,
- * but does not report other types of errors such as system configuration
- * errors (these are just handled as exceptions).
+ * This class reports errors that occur while parsing, validating or
+ * manipulating WSDL descriptions, such as XML parser errors or violations
+ * of the rules defined in the WSDL specification. That is, errors that
+ * relate specifically to the WSDL. It does not report system runtime
+ * or configuration errors, which are instead treated as exceptions.
+ *
* TODO for now we will treat any error returned by the XML parser as a
- * fatal error and throw a WSDLException after reporting the fatal error.
- * We may need to think later about handling multiple
+ * fatal error, but we may need to rethink this later.
+ * <p>
+ * An error originates with an error key, a set of message arguments and
+ * a severity (warning, error or fatal error). A formatted message is
+ * produced and the error is then handled according to the severity.
* <p/>
- * It orchestrates the reporting by first using a message formatter to create
- * formatted errors then invoking an error handler to actually do
- * something with the error. It supports the 'en' (English) locale by default
- * and has a default error handler. However, it may optionally be configured
- * with a different locale used for localizing error messages and a custom
error
- * handler.
+ * The error reporter supports the 'en' (English) locale by default
+ * and has a default error handler (i.e. a default implementation of
+ * ErrorHandler). However, a different locale may be configured
+ * via <code>setLocale</code> and a custom error handler implementation
+ * may be configured as a system property.
*
* @author [EMAIL PROTECTED]
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
