Revision: 1624
http://svn.sourceforge.net/spring-rich-c/?rev=1624&view=rev
Author: kevinstembridge
Date: 2007-01-08 04:59:53 -0800 (Mon, 08 Jan 2007)
Log Message:
-----------
Added javadoc
Modified Paths:
--------------
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/application/ViewDescriptorRegistry.java
Modified:
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/application/ViewDescriptorRegistry.java
===================================================================
---
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/application/ViewDescriptorRegistry.java
2007-01-04 13:05:51 UTC (rev 1623)
+++
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/application/ViewDescriptorRegistry.java
2007-01-08 12:59:53 UTC (rev 1624)
@@ -15,8 +15,31 @@
*/
package org.springframework.richclient.application;
+/**
+ * A registry for [EMAIL PROTECTED] ViewDescriptor} definitions.
+ *
+ * @author Keith Donald
+ *
+ */
public interface ViewDescriptorRegistry {
+
+ /**
+ * Returns an array of all the view descriptors in the registry.
+ *
+ * @return An array of all the view descriptors in the registry. The array
may be empty but
+ * will never be null.
+ */
public ViewDescriptor[] getViewDescriptors();
+ /**
+ * Returns the view descriptor with the given identifier, or null if no
such descriptor
+ * exists in the registry.
+ *
+ * @param viewDescriptorId The id of the view descriptor to be returned.
+ * @return The view descriptor with the given id, or null.
+ *
+ * @throws IllegalArgumentException if [EMAIL PROTECTED] viewDescriptorId}
is null.
+ */
public ViewDescriptor getViewDescriptor(String viewDescriptorId);
-}
\ No newline at end of file
+
+}
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
spring-rich-c-cvs mailing list
spring-rich-c-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/spring-rich-c-cvs
