You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by sb...@apache.org on 2015/06/02 21:55:37 UTC
[39/50] [abbrv] incubator-ignite git commit: # ignite-sprint-5 Added
javadoc.
# ignite-sprint-5 Added javadoc.
Project: http://git-wip-us.apache.org/repos/asf/incubator-ignite/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-ignite/commit/31fcc3e8
Tree: http://git-wip-us.apache.org/repos/asf/incubator-ignite/tree/31fcc3e8
Diff: http://git-wip-us.apache.org/repos/asf/incubator-ignite/diff/31fcc3e8
Branch: refs/heads/ignite-948
Commit: 31fcc3e8b760c2773e475770d819d433e8d19f4a
Parents: 5c30f9c
Author: sboikov <sb...@gridgain.com>
Authored: Mon Jun 1 09:39:57 2015 +0300
Committer: sboikov <sb...@gridgain.com>
Committed: Mon Jun 1 09:39:57 2015 +0300
----------------------------------------------------------------------
.../configuration/IgniteConfiguration.java | 6 +++++
.../apache/ignite/plugin/PluginProvider.java | 26 ++++++++++++++------
2 files changed, 25 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/31fcc3e8/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java b/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java
index ebe2b8e..3d4b64b 100644
--- a/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java
+++ b/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java
@@ -2188,15 +2188,21 @@ public class IgniteConfiguration {
}
/**
+ * Gets plugin configurations.
+ *
* @return Plugin configurations.
+ * @see PluginProvider
*/
public PluginConfiguration[] getPluginConfigurations() {
return pluginCfgs;
}
/**
+ * Sets plugin configurations.
+ *
* @param pluginCfgs Plugin configurations.
* @return {@code this} for chaining.
+ * @see PluginProvider
*/
public IgniteConfiguration setPluginConfigurations(PluginConfiguration... pluginCfgs) {
this.pluginCfgs = pluginCfgs;
http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/31fcc3e8/modules/core/src/main/java/org/apache/ignite/plugin/PluginProvider.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/plugin/PluginProvider.java b/modules/core/src/main/java/org/apache/ignite/plugin/PluginProvider.java
index 17bbc36..f064fde 100644
--- a/modules/core/src/main/java/org/apache/ignite/plugin/PluginProvider.java
+++ b/modules/core/src/main/java/org/apache/ignite/plugin/PluginProvider.java
@@ -19,13 +19,22 @@ package org.apache.ignite.plugin;
import org.apache.ignite.*;
import org.apache.ignite.cluster.*;
+import org.apache.ignite.configuration.*;
import org.jetbrains.annotations.*;
import java.io.*;
import java.util.*;
/**
- * Pluggable ignite component.
+ * Pluggable Ignite component.
+ * <p>
+ * Ignite plugins are loaded using JDK {@link ServiceLoader}.
+ * First method called to initialize plugin is {@link PluginProvider#initExtensions(PluginContext, ExtensionRegistry)}.
+ * If plugin requires configuration it can be set in {@link IgniteConfiguration} using
+ * {@link IgniteConfiguration#setPluginConfigurations(PluginConfiguration...)}.
+ *
+ * @see IgniteConfiguration#setPluginConfigurations(PluginConfiguration...)
+ * @see PluginContext
*/
public interface PluginProvider<C extends PluginConfiguration> {
/**
@@ -49,18 +58,21 @@ public interface PluginProvider<C extends PluginConfiguration> {
public <T extends IgnitePlugin> T plugin();
/**
+ * Registers extensions.
+ *
* @param ctx Plugin context.
- * @param cls Ignite component class.
- * @return Ignite component or {@code null} if component is not supported.
+ * @param registry Extension registry.
*/
- @Nullable public <T> T createComponent(PluginContext ctx, Class<T> cls);
+ public void initExtensions(PluginContext ctx, ExtensionRegistry registry);
/**
- * Register extensions.
+ * Creates Ignite component.
+ *
* @param ctx Plugin context.
- * @param registry Extension registry.
+ * @param cls Ignite component class.
+ * @return Ignite component or {@code null} if component is not supported.
*/
- public void initExtensions(PluginContext ctx, ExtensionRegistry registry);
+ @Nullable public <T> T createComponent(PluginContext ctx, Class<T> cls);
/**
* Starts grid component.