aboutsummaryrefslogtreecommitdiffstats
path: root/src/com/itmill/toolkit/terminal/UserError.java
diff options
context:
space:
mode:
authorJani Laakso <jani.laakso@itmill.com>2007-04-12 14:41:25 +0000
committerJani Laakso <jani.laakso@itmill.com>2007-04-12 14:41:25 +0000
commit544a4770365be51e26b1b8418f2f4226db5bcb15 (patch)
treec5ef61d190d461a3aa789ef8444159f7bd1bd7b3 /src/com/itmill/toolkit/terminal/UserError.java
parentfde5869b30ae8da8ec5d884d3438815e1a63aca1 (diff)
downloadvaadin-framework-544a4770365be51e26b1b8418f2f4226db5bcb15.tar.gz
vaadin-framework-544a4770365be51e26b1b8418f2f4226db5bcb15.zip
Pulled changesets from branches/4.0.0-SRIT into trunk, done by
mohamed.atique@renaissance-it.com. All changes are related to javadocs only. Merge was done beetween revisions 924:1192. svn changeset:1212/svn branch:trunk
Diffstat (limited to 'src/com/itmill/toolkit/terminal/UserError.java')
-rw-r--r--src/com/itmill/toolkit/terminal/UserError.java35
1 files changed, 25 insertions, 10 deletions
diff --git a/src/com/itmill/toolkit/terminal/UserError.java b/src/com/itmill/toolkit/terminal/UserError.java
index f71d40ab17..2a838d0b8a 100644
--- a/src/com/itmill/toolkit/terminal/UserError.java
+++ b/src/com/itmill/toolkit/terminal/UserError.java
@@ -28,7 +28,8 @@
package com.itmill.toolkit.terminal;
-/** User error is a controlled error occurred in application. User errors
+/**
+ * <code>UserError</code> is a controlled error occurred in application. User errors
* are occur in normal usage of the application and guide the user.
*
* @author IT Mill Ltd.
@@ -37,37 +38,51 @@ package com.itmill.toolkit.terminal;
*/
public class UserError implements ErrorMessage {
- /** Content mode, where the error contains only plain text.
+ /**
+ * Content mode, where the error contains only plain text.
*/
public static final int CONTENT_TEXT = 0;
- /** Content mode, where the error contains preformatted text.
+ /**
+ * Content mode, where the error contains preformatted text.
*/
public static final int CONTENT_PREFORMATTED = 1;
- /** Formatted content mode, where the contents is XML restricted to the
+ /**
+ * Formatted content mode, where the contents is XML restricted to the
* UIDL 1.0 formatting markups.
*/
public static final int CONTENT_UIDL = 2;
- /** Content mode */
+ /**
+ * Content mode.
+ */
private int mode = CONTENT_TEXT;
- /** Message in content mode */
+ /**
+ * Message in content mode.
+ */
private String msg;
- /** Error level */
+ /**
+ * Error level.
+ */
private int level = ErrorMessage.ERROR;
- /** Create a textual error message of level ERROR.
+ /**
+ * Creates a textual error message of level ERROR.
*
- * @param textErrorMessage The text of the error message.
+ * @param textErrorMessage the text of the error message.
*/
public UserError(String textErrorMessage) {
this.msg = textErrorMessage;
}
- /** Create error message with level and content mode.
+ /**
+ * Creates error message with level and content mode.
+ * @param message the error message.
+ * @param contentMode the content Mode.
+ * @param errorLevel the level of error.
*/
public UserError(String message, int contentMode, int errorLevel) {