summaryrefslogtreecommitdiff
path: root/java/src/IceSSL/PluginFactory.java
diff options
context:
space:
mode:
authorMichi Henning <michi@zeroc.com>2009-06-10 16:06:51 +1000
committerMichi Henning <michi@zeroc.com>2009-06-10 16:06:51 +1000
commit918a6ee99820a09620599575e951cb0e5530d82b (patch)
tree108ca0dfd6d733ca76ddbedc70d5cc043151dda7 /java/src/IceSSL/PluginFactory.java
parentFixed bug in depednedncy creation (diff)
downloadice-918a6ee99820a09620599575e951cb0e5530d82b.tar.bz2
ice-918a6ee99820a09620599575e951cb0e5530d82b.tar.xz
ice-918a6ee99820a09620599575e951cb0e5530d82b.zip
Bug 3502 - Improve javadoc support in Eclipse.
Added more comments. Source files are now added to Ice.jar and Freeze.jar.
Diffstat (limited to 'java/src/IceSSL/PluginFactory.java')
-rw-r--r--java/src/IceSSL/PluginFactory.java14
1 files changed, 14 insertions, 0 deletions
diff --git a/java/src/IceSSL/PluginFactory.java b/java/src/IceSSL/PluginFactory.java
index fab146a9e6a..0e7fdf0c537 100644
--- a/java/src/IceSSL/PluginFactory.java
+++ b/java/src/IceSSL/PluginFactory.java
@@ -9,8 +9,22 @@
package IceSSL;
+/**
+ * Plug-in factories must implement this interface.
+ **/
public class PluginFactory implements Ice.PluginFactory
{
+ /**
+ * Returns a new plug-in.
+ *
+ * @param communicator The communicator for the plug-in.
+ * @param name The name of the plug-in.
+ * @param args The arguments that are specified in the plug-in's configuration.
+ *
+ * @return The new plug-in. <code>null</code> can be returned to indicate
+ * that a general error occurred. Alterntively, <code>create</code> can throw
+ * <code>PluginInitializationException</code> to provide more detailed information.
+ **/
public Ice.Plugin
create(Ice.Communicator communicator, String name, String[] args)
{