Revision: 1787
http://spring-rich-c.svn.sourceforge.net/spring-rich-c/?rev=1787&view=rev
Author: jhoskens
Date: 2007-07-25 03:52:48 -0700 (Wed, 25 Jul 2007)
Log Message:
-----------
added javadoc
Modified Paths:
--------------
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/MutablePropertyAccessStrategy.java
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/PropertyAccessStrategy.java
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/value/PropertyChangePublisher.java
Modified:
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/MutablePropertyAccessStrategy.java
===================================================================
---
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/MutablePropertyAccessStrategy.java
2007-07-25 07:57:08 UTC (rev 1786)
+++
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/MutablePropertyAccessStrategy.java
2007-07-25 10:52:48 UTC (rev 1787)
@@ -25,23 +25,51 @@
* </p>
* <ul>
* <li>registering custom property editors for performing type conversions
- * <li>returning a domain object holder allowing the underlying domain object
to
- * be changed and subscribed to for modification, and
+ * <li>returning a domain object holder allowing the underlying domain object
+ * to be changed and subscribed to for modification, and
* <li>adding listeners for changes on particular properties.
* </ul>
- * EXPERIMENTAL - not yet fit for general use
+ *
* @author Keith Donald
*/
public interface MutablePropertyAccessStrategy extends PropertyAccessStrategy {
- public ValueModel getDomainObjectHolder();
+ /**
+ * Get the <code>ValueModel</code> used to access the domainObject.
+ *
+ * @return the <code>ValueModel</code> of the domainObject.
+ */
+ ValueModel getDomainObjectHolder();
- public ValueModel getPropertyValueModel(String propertyPath)
- throws BeansException;
+ /**
+ * Get the <code>ValueModel</code> to access the given property.
Possibly
+ * creating the valueModel if needed.
+ *
+ * @param propertyPath property to access.
+ * @return <code>ValueModel</code> that handles the given property.
+ * @throws BeansException
+ */
+ ValueModel getPropertyValueModel(String propertyPath) throws
BeansException;
- public MutablePropertyAccessStrategy getPropertyAccessStrategyForPath(
- String propertyPath) throws BeansException;
+ /**
+ * Get a <code>MutablePropertyAccessStrategy</code> for the given
property.
+ *
+ * TODO check why this exists and where this is used.
+ *
+ * @param propertyPath property.
+ * @return <code>MutablePropertyAccessStrategy</code> for the given
property.
+ * @throws BeansException
+ */
+ MutablePropertyAccessStrategy getPropertyAccessStrategyForPath(String
propertyPath) throws BeansException;
- public MutablePropertyAccessStrategy newPropertyAccessStrategy(ValueModel
domainObjectHolder);
+ /**
+ * Return a new <code>MutablePropertyAccessStrategy</code> for the
given valueModel.
+ *
+ * TODO check why this exists and where this is used.
+ *
+ * @param domainObjectHolder a <code>ValueModel</code> containing the
domainObject.
+ * @return a newly created <code>MutablePropertyAccessStrategy</code>.
+ */
+ MutablePropertyAccessStrategy newPropertyAccessStrategy(ValueModel
domainObjectHolder);
}
\ No newline at end of file
Modified:
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/PropertyAccessStrategy.java
===================================================================
---
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/PropertyAccessStrategy.java
2007-07-25 07:57:08 UTC (rev 1786)
+++
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/PropertyAccessStrategy.java
2007-07-25 10:52:48 UTC (rev 1787)
@@ -23,37 +23,35 @@
* implementations could access different backing objects such as a javabean
* <code>(BeanPropertyAccessStrategy)</code>, hashmap, rowset, or other data
* structure.
- * EXPERIMENTAL - not yet fit for general use
+ *
* @author Keith Donald
*/
public interface PropertyAccessStrategy {
- /**
- * Get the value of a property.
- *
- * @param propertyPath
- * name of the property to get the value of
- * @return the value of the property
- * @throws FatalBeanException
- * if there is no such property, if the property isn't
readable,
- * or if the property getter throws an exception.
- */
- public Object getPropertyValue(String propertyPath) throws BeansException;
+ /**
+ * Get the value of a property.
+ *
+ * @param propertyPath name of the property to get the value of
+ * @return the value of the property
+ * @throws FatalBeanException if there is no such property, if the
property
+ * isn't readable, or if the property getter throws an exception.
+ */
+ Object getPropertyValue(String propertyPath) throws BeansException;
- /**
- * Get a metadata accessor, which can return meta information about
- * particular properties of the backed domain object.
- *
- * @return The meta accessor.
- */
- public PropertyMetadataAccessStrategy getMetadataAccessStrategy();
+ /**
+ * Get a metadata accessor, which can return meta information about
+ * particular properties of the backed domain object.
+ *
+ * @return The meta accessor.
+ */
+ PropertyMetadataAccessStrategy getMetadataAccessStrategy();
- /**
- * Return the target, backing domain object for which property access
- * requests are targeted against.
- *
- * @return The backing target object.
- */
- public Object getDomainObject();
+ /**
+ * Return the target, backing domain object for which property access
+ * requests are targeted against.
+ *
+ * @return The backing target object.
+ */
+ Object getDomainObject();
}
\ No newline at end of file
Modified:
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/value/PropertyChangePublisher.java
===================================================================
---
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/value/PropertyChangePublisher.java
2007-07-25 07:57:08 UTC (rev 1786)
+++
trunk/spring-richclient/binding/src/main/java/org/springframework/binding/value/PropertyChangePublisher.java
2007-07-25 10:52:48 UTC (rev 1787)
@@ -25,13 +25,34 @@
* @author Keith Donald
*/
public interface PropertyChangePublisher {
- public void addPropertyChangeListener(PropertyChangeListener listener);
- public void addPropertyChangeListener(String propertyName,
- PropertyChangeListener listener);
+ /**
+ * Register a listener to all properties of this publisher.
+ *
+ * @param listener the <code>PropertyChangeListener</code> to register.
+ */
+ void addPropertyChangeListener(PropertyChangeListener listener);
- public void removePropertyChangeListener(PropertyChangeListener listener);
+ /**
+ * Register a listener to a specific property.
+ *
+ * @param propertyName the property to monitor.
+ * @param listener the <code>PropertyChangeListener</code> to register.
+ */
+ void addPropertyChangeListener(String propertyName,
PropertyChangeListener listener);
- public void removePropertyChangeListener(String propertyName,
- PropertyChangeListener listener);
+ /**
+ * Remove the listener from all properties of this publisher.
+ *
+ * @param listener the <code>PropertyChangeListener</code> to remove.
+ */
+ void removePropertyChangeListener(PropertyChangeListener listener);
+
+ /**
+ * Remove the listener from a specific property.
+ *
+ * @param propertyName the property that was being monitored.
+ * @param listener the <code>PropertyChangeListener</code> to remove.
+ */
+ void removePropertyChangeListener(String propertyName,
PropertyChangeListener listener);
}
\ 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
