summaryrefslogtreecommitdiff
path: root/java/src/Ice/PluginFactory.java
diff options
context:
space:
mode:
Diffstat (limited to 'java/src/Ice/PluginFactory.java')
-rw-r--r--java/src/Ice/PluginFactory.java12
1 files changed, 12 insertions, 0 deletions
diff --git a/java/src/Ice/PluginFactory.java b/java/src/Ice/PluginFactory.java
index 4017d3ea0c2..e4b9913211d 100644
--- a/java/src/Ice/PluginFactory.java
+++ b/java/src/Ice/PluginFactory.java
@@ -9,7 +9,19 @@
package Ice;
+/**
+ * Applications implement this interface to provide a plug-in factory
+ * to the Ice run time.
+ **/
public interface PluginFactory
{
+ /**
+ * Called by the Ice run time to create a new plug-in.
+ *
+ * @param communicator The communicator that is in the process of being initialized.
+ * @param name The name of the plug-in.
+ * @param args The arguments that are specified in the plug-ins configuration.
+ * @return The plug-in that was created by this method.
+ **/
Plugin create(Communicator communicator, String name, String[] args);
}