Revision: 1786
http://spring-rich-c.svn.sourceforge.net/spring-rich-c/?rev=1786&view=rev
Author: jhoskens
Date: 2007-07-25 00:57:08 -0700 (Wed, 25 Jul 2007)
Log Message:
-----------
Added javadoc
Modified Paths:
--------------
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/PropertyMetadataAccessStrategy.java
Modified:
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/PropertyMetadataAccessStrategy.java
===================================================================
---
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/PropertyMetadataAccessStrategy.java
2007-07-19 12:03:47 UTC (rev 1785)
+++
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/PropertyMetadataAccessStrategy.java
2007-07-25 07:57:08 UTC (rev 1786)
@@ -20,29 +20,52 @@
/**
* Simple interface for accessing metadata about a particular property.
*
- * EXPERIMENTAL - not yet fit for general use
* @author Keith Donald
*/
public interface PropertyMetadataAccessStrategy {
- public boolean isReadable(String propertyName);
- public boolean isWriteable(String propertyName);
+ /**
+ * Determine if the given property is readable.
+ *
+ * @param propertyName property to examine.
+ * @return <code>true</code> if the property is readable.
+ */
+ boolean isReadable(String propertyName);
- public Class getPropertyType(String propertyName);
+ /**
+ * Determine if the given property is writeable.
+ *
+ * @param propertyName property to examine.
+ * @return <code>true</code> if the property is writeable.
+ */
+ boolean isWriteable(String propertyName);
- /**
- * Returns custom metadata that may be associated with the specified
- * property path.
- */
- Object getUserMetadata(String propertyName, String key);
+ /**
+ * Get the type of the given property.
+ *
+ * @param propertyName property to examine.
+ * @return the type of the property.
+ */
+ Class getPropertyType(String propertyName);
- /**
- * Returns all custom metadata associated with the specified property
- * in the form of a Map.
- *
- * @return Map containing String keys - this method may or may not return
- * <code>null</code> if there is no custom metadata associated
- * with the property.
- */
- Map getAllUserMetadata(String propertyName);
+ /**
+ * Returns custom metadata that may be associated with the specified
+ * property path.
+ *
+ * @param propertyName property to examine.
+ * @param key used to retreive the metadata.
+ * @return Object stored under the given key.
+ */
+ Object getUserMetadata(String propertyName, String key);
+
+ /**
+ * Returns all custom metadata associated with the specified property
in the
+ * form of a Map.
+ *
+ * @param propertyName property to examine.
+ * @return Map containing String keys - this method may or may not
return
+ * <code>null</code> if there is no custom metadata associated with the
+ * property.
+ */
+ Map getAllUserMetadata(String propertyName);
}
\ 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
