Author: slotia
Date: 2013-01-18 11:05:45 -0800 (Fri, 18 Jan 2013)
New Revision: 31057
Modified:
core3/api/trunk/service-api/src/main/java/org/cytoscape/service/util/CyServiceRegistrar.java
core3/api/trunk/service-api/src/main/java/org/cytoscape/service/util/internal/CyServiceRegistrarImpl.java
Log:
Updated service api docs
Modified:
core3/api/trunk/service-api/src/main/java/org/cytoscape/service/util/CyServiceRegistrar.java
===================================================================
---
core3/api/trunk/service-api/src/main/java/org/cytoscape/service/util/CyServiceRegistrar.java
2013-01-18 18:38:52 UTC (rev 31056)
+++
core3/api/trunk/service-api/src/main/java/org/cytoscape/service/util/CyServiceRegistrar.java
2013-01-18 19:05:45 UTC (rev 31057)
@@ -7,9 +7,11 @@
/**
* An interface to hide the OSGi dependencies needed to register
- * services dynamically at runtime. You should only use this interface
- * if you need to register services while running based on data not
- * available at startup.
+ * services dynamically at runtime. This provides similar methods to
+ * {@code AbstractCyActivator}, but you should only use {@code
CyServiceRegistrar}
+ * if you need to register services outside of {@code AbstractCyActivator}'s
+ * {@code start} method.
+ *
* @CyAPI.Api.Interface
* @CyAPI.InModule service-api
*/
Modified:
core3/api/trunk/service-api/src/main/java/org/cytoscape/service/util/internal/CyServiceRegistrarImpl.java
===================================================================
---
core3/api/trunk/service-api/src/main/java/org/cytoscape/service/util/internal/CyServiceRegistrarImpl.java
2013-01-18 18:38:52 UTC (rev 31056)
+++
core3/api/trunk/service-api/src/main/java/org/cytoscape/service/util/internal/CyServiceRegistrarImpl.java
2013-01-18 19:05:45 UTC (rev 31057)
@@ -19,6 +19,13 @@
import org.cytoscape.service.util.internal.utils.RegisterUtil;
import org.cytoscape.service.util.internal.utils.ServiceUtil;
+/**
+ * Implementation of {@code CyServiceRegistrar}.
+ *
+ * This is part of {@code service-api} instead of {@code service-impl}. This
class uses code from {@code ServiceUtil},
+ * which is also used by {@code AbstractCyActivator}. This class has to be
+ * part of {@code service-api} so that it can use {@code ServiceUtil}.
+ */
public class CyServiceRegistrarImpl implements CyServiceRegistrar{
//private static final Logger logger =
LoggerFactory.getLogger(CyServiceRegistrarImpl.class);
--
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.
