Author: mkirby
Date: 2011-10-07 14:24:23 -0700 (Fri, 07 Oct 2011)
New Revision: 27090
Modified:
core3/api/trunk/property-api/src/main/java/org/cytoscape/property/BasicCyProperty.java
core3/api/trunk/property-api/src/main/java/org/cytoscape/property/CyProperty.java
core3/api/trunk/property-api/src/main/java/org/cytoscape/property/bookmark/BookmarksUtil.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/property-api/src/main/java/org/cytoscape/property/BasicCyProperty.java
===================================================================
---
core3/api/trunk/property-api/src/main/java/org/cytoscape/property/BasicCyProperty.java
2011-10-07 21:22:53 UTC (rev 27089)
+++
core3/api/trunk/property-api/src/main/java/org/cytoscape/property/BasicCyProperty.java
2011-10-07 21:24:23 UTC (rev 27090)
@@ -23,6 +23,7 @@
* should encapsulate.
* @param properties The non-null Properties object this CyProperty
object
* should encapsulate. Throws NullPointerException if Properties is
null.
+ * @param savePolicy the {@link CyProperty.SavePolicy} of this
CyProperty object.
*/
public BasicCyProperty(final Properties properties, final
CyProperty.SavePolicy savePolicy) {
if (properties == null)
Modified:
core3/api/trunk/property-api/src/main/java/org/cytoscape/property/CyProperty.java
===================================================================
---
core3/api/trunk/property-api/src/main/java/org/cytoscape/property/CyProperty.java
2011-10-07 21:22:53 UTC (rev 27089)
+++
core3/api/trunk/property-api/src/main/java/org/cytoscape/property/CyProperty.java
2011-10-07 21:24:23 UTC (rev 27090)
@@ -8,9 +8,15 @@
* {@link org.cytoscape.property.bookmark.Bookmarks}, or
* {@link org.cytoscape.property.session.Cysession}, although it is possible
for
* property objects of other types to be registered in this way as well.
+ * @param <P> The generic type for the CyProperty. Generally one of three
types:
+ * {@link java.util.Properties},
+ * {@link org.cytoscape.property.bookmark.Bookmarks}, or
+ * {@link org.cytoscape.property.session.Cysession}, although it is possible
for
+ * property objects of other types to be registered in this way as well.
*/
public interface CyProperty<P> {
+ /** SavePolicy specifies how the CyProperty will be saved, or if it
will not be saved. */
enum SavePolicy {
/** These properties are preset by Cytoscape to some default
value and
* are never written out. */
@@ -35,5 +41,9 @@
*/
P getProperties();
+ /**
+ * Returns the {@link SavePolicy} of the CyProperty.
+ * @return the {@link SavePolicy} of the CyProperty.
+ */
SavePolicy getSavePolicy();
}
Modified:
core3/api/trunk/property-api/src/main/java/org/cytoscape/property/bookmark/BookmarksUtil.java
===================================================================
---
core3/api/trunk/property-api/src/main/java/org/cytoscape/property/bookmark/BookmarksUtil.java
2011-10-07 21:22:53 UTC (rev 27089)
+++
core3/api/trunk/property-api/src/main/java/org/cytoscape/property/bookmark/BookmarksUtil.java
2011-10-07 21:24:23 UTC (rev 27090)
@@ -10,7 +10,8 @@
* Traverse bookmark tree and get a list of data sources from the
specified
* category.
*
- * @param categoryName
+ * @param categoryName the specified category to get a list of data
sources from.
+ * @param categoryList the list of categories to traverse for the
specified category.
* @return a list of data sources from the specified category.
*/
List<DataSource> getDataSourceList(String categoryName, List<Category>
categoryList);
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
