Revision: 1796
http://spring-rich-c.svn.sourceforge.net/spring-rich-c/?rev=1796&view=rev
Author: kevinstembridge
Date: 2007-08-01 14:02:09 -0700 (Wed, 01 Aug 2007)
Log Message:
-----------
Added javadoc
Modified Paths:
--------------
trunk/spring-richclient/core/src/main/java/org/springframework/richclient/core/Message.java
Modified:
trunk/spring-richclient/core/src/main/java/org/springframework/richclient/core/Message.java
===================================================================
---
trunk/spring-richclient/core/src/main/java/org/springframework/richclient/core/Message.java
2007-07-31 22:41:46 UTC (rev 1795)
+++
trunk/spring-richclient/core/src/main/java/org/springframework/richclient/core/Message.java
2007-08-01 21:02:09 UTC (rev 1796)
@@ -17,7 +17,12 @@
import javax.swing.JComponent;
-
+/**
+ * An interface to be implemented by classes that represent a user-oriented
message and
+ * are capable of rendering themselves on GUI components.
+ *
+ * @see JComponent
+ */
public interface Message {
/**
@@ -28,12 +33,15 @@
long getTimestamp();
/**
- * @return textual message.
+ * The textual representation of the message. This is not necessarily how
the
+ * message will appear on a GUI component.
+ *
+ * @return textual message, never null, but possibly an empty string.
*/
String getMessage();
/**
- * @return Severity of this message.
+ * @return Severity of this message, possibly null.
*/
Severity getSeverity();
@@ -41,4 +49,5 @@
* @param component visual component to decorate.
*/
void renderMessage(JComponent component);
-}
\ No newline at end of file
+
+}
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
spring-rich-c-cvs mailing list
spring-rich-c-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/spring-rich-c-cvs
