Author: mkirby
Date: 2011-11-07 17:24:06 -0800 (Mon, 07 Nov 2011)
New Revision: 27427
Modified:
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/CyNetworkNaming.java
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/CySession.java
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/CySessionManager.java
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedEvent.java
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedListener.java
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionLoadedEvent.java
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionLoadedListener.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/CyNetworkNaming.java
===================================================================
---
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/CyNetworkNaming.java
2011-11-08 00:59:34 UTC (rev 27426)
+++
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/CyNetworkNaming.java
2011-11-08 01:24:06 UTC (rev 27427)
@@ -6,12 +6,13 @@
/**
* A utility that helps with the creation of unique network names.
+ * @CyAPI.Api.Interface
*/
public interface CyNetworkNaming {
/**
- * Generates a unique title for a subnetwork based on a parent network
- * @param parentNetwork a non-null reference to a parent network
- * @return a unique title somehow based on the title of the parent
network
+ * Generates a unique title for a subnetwork based on a parent network.
+ * @param parentNetwork a non-null reference to a parent network.
+ * @return a unique title somehow based on the title of the parent
network.
*/
String getSuggestedSubnetworkTitle(CyNetwork parentNetwork);
@@ -19,7 +20,7 @@
* Generates a unique network title based on a provided suggestion.
* @param desiredTitle the "ideal" title that we would like
* @return "desiredTitle" if this title is not yet in use, or
- * with a title that is unique and uses "desiredTitle" as a prefix
+ * with a title that is unique and uses "desiredTitle" as a prefix.
*/
String getSuggestedNetworkTitle(String desiredTitle);
}
Modified:
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/CySession.java
===================================================================
---
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/CySession.java
2011-11-08 00:59:34 UTC (rev 27426)
+++
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/CySession.java
2011-11-08 01:24:06 UTC (rev 27427)
@@ -56,12 +56,13 @@
* <br/>
* Creating an instance of CySession is done following the builder pattern.
* For example, the following code creates a session that only includes
- * a list of networkViews and cytoscape properties, but nothing else.
+ * a list of networkViews and Cytoscape properties, but nothing else.
* <br/>
* <pre>
* CySession session = new
CySession.Builder().networkViews(viewList).cytoscapeProperties(cyProps).build();
* </pre>
* <br/>
+ * @CyAPI.Final.Class
*/
public final class CySession {
@@ -123,6 +124,7 @@
/**
* A implementation of the builder pattern used to construct immutable
* instances of CySession objects.
+ * @CyAPI.Static.Class
*/
public static class Builder {
Modified:
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/CySessionManager.java
===================================================================
---
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/CySessionManager.java
2011-11-08 00:59:34 UTC (rev 27426)
+++
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/CySessionManager.java
2011-11-08 01:24:06 UTC (rev 27427)
@@ -4,14 +4,15 @@
/**
* This class primarily acts as a listener and tracks the state of
* the Cytoscape application. This state can be interrogated at any
- * time and the result is an immutable CySession object suitable
+ * time and the result is an immutable {@link CySession} object suitable
* for serialization. Likewise, setting a new session will replace
* the current session with a new one.
+ * @CyAPI.Api.Interface
*/
public interface CySessionManager {
/**
- * This method returns a CySession object describing the current
+ * This method returns a {@link CySession} object describing the current
* state of Cytoscape. The object returned is meant to
* be used for serialization and is not meant to be used interactively
* to track the state of Cytsocape.
Modified:
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedEvent.java
===================================================================
---
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedEvent.java
2011-11-08 00:59:34 UTC (rev 27426)
+++
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedEvent.java
2011-11-08 01:24:06 UTC (rev 27427)
@@ -14,10 +14,11 @@
import org.cytoscape.session.CySessionManager;
/**
- * This event is fired synchronously by the CySessionManager at beginning of
the
+ * This event is fired synchronously by the {@link CySessionManager} at
beginning of the
* {@link CySessionManager#getCurrentSession()} method. The intent is to allow
* listeners to provide information to this event object or to update their
* state before that state is interrogated by the CySessionManager.
+ * @CyAPI.Final.Class
*/
public final class SessionAboutToBeSavedEvent extends
AbstractCyEvent<CySessionManager> {
@@ -28,7 +29,7 @@
// TODO should the source be the session manager??
/**
* Constructor.
- * @param source The CySessionManager that will be saving the session.
+ * @param source The {@link CySessionManager} that will be saving the
session.
*/
public SessionAboutToBeSavedEvent(final CySessionManager source) {
super(source, SessionAboutToBeSavedListener.class);
@@ -66,7 +67,7 @@
/**
* This method is not meant to be used by listeners for this event,
* although you can and no harm should come to you. This method is
- * used by the CySessionManager to retrieve the list of files from
+ * used by the {@link CySessionManager} to retrieve the list of files
from
* plugins.
* @return A map of plugin names to lists of files to be stored in the
* session for that plugin.
@@ -108,7 +109,8 @@
* A method that allows plugins to add Cytopanel-related information to
be
* stored in the session.
* @param cytopanel The CytoPanel to be added.
- * @throws NullPointerException If the cytopanel to be added is null.
+ * @throws Exception
+ * @throws NullPointerException If the Cytopanel to be added is null.
*/
public void addCytopanel(Cytopanel cytopanel) throws Exception {
if (cytopanel == null)
Modified:
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedListener.java
===================================================================
---
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedListener.java
2011-11-08 00:59:34 UTC (rev 27426)
+++
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedListener.java
2011-11-08 01:24:06 UTC (rev 27427)
@@ -4,10 +4,11 @@
import org.cytoscape.event.CyListener;
/**
- * Any object that needs to know that a CySession is about to be
+ * Any object that needs to know that a {@link
org.cytoscape.session.CySession} is about to be
* created listen to this event. Additionally, plugins can set
* a list of files to be saved in the CySession using the
- * appropriate method in the SessionAboutToBeSavedEvent.
+ * appropriate method in the {@link SessionAboutToBeSavedEvent}.
+ * @CyAPI.Spi.Interface
*/
public interface SessionAboutToBeSavedListener extends CyListener {
Modified:
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionLoadedEvent.java
===================================================================
---
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionLoadedEvent.java
2011-11-08 00:59:34 UTC (rev 27426)
+++
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionLoadedEvent.java
2011-11-08 01:24:06 UTC (rev 27427)
@@ -10,6 +10,7 @@
* {@link CySessionManager#setCurrentSession(CySession, String)}
* method and is used to notify interested parties in the change
* of state.
+ * @CyAPI.Final.Class
*/
public final class SessionLoadedEvent extends
AbstractCyEvent<CySessionManager> {
@@ -18,8 +19,8 @@
/**
* Constructor.
- * @param source The CySessionManager that is the source of this event.
- * @param session The CySession object that was just loaded.
+ * @param source The {@link CySessionManager} that is the source of
this event.
+ * @param session The {@link CySession} object that was just loaded.
* @param fileName the name of the file representing the session.
*/
public SessionLoadedEvent(final CySessionManager source, final
CySession session, final String fileName) {
Modified:
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionLoadedListener.java
===================================================================
---
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionLoadedListener.java
2011-11-08 00:59:34 UTC (rev 27426)
+++
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionLoadedListener.java
2011-11-08 01:24:06 UTC (rev 27427)
@@ -5,6 +5,7 @@
/**
* A listener for {@link SessionLoadedEvent}s.
+ * @CyAPI.Spi.Interface
*/
public interface SessionLoadedListener extends CyListener {
/**
--
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.
