# Minor JavaDoc fixes.
Project: http://git-wip-us.apache.org/repos/asf/incubator-ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-ignite/commit/cefc8855 Tree: http://git-wip-us.apache.org/repos/asf/incubator-ignite/tree/cefc8855 Diff: http://git-wip-us.apache.org/repos/asf/incubator-ignite/diff/cefc8855 Branch: refs/heads/ignite-368 Commit: cefc8855b5d18c6ab2c27ec88f51f0bf8c73476f Parents: 55c093d Author: vozerov-gridgain <voze...@gridgain.com> Authored: Fri Feb 27 13:49:44 2015 +0300 Committer: vozerov-gridgain <voze...@gridgain.com> Committed: Fri Feb 27 13:49:44 2015 +0300 ---------------------------------------------------------------------- .../src/main/java/org/apache/ignite/Ignite.java | 4 +-- .../configuration/QueryConfiguration.java | 37 ++++++++++++++++---- 2 files changed, 33 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/cefc8855/modules/core/src/main/java/org/apache/ignite/Ignite.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/Ignite.java b/modules/core/src/main/java/org/apache/ignite/Ignite.java index a120701..8851d8f 100644 --- a/modules/core/src/main/java/org/apache/ignite/Ignite.java +++ b/modules/core/src/main/java/org/apache/ignite/Ignite.java @@ -37,7 +37,7 @@ import java.util.concurrent.*; * each instance a different name. * <p> * Note that {@code Grid} extends {@link ClusterGroup} which means that it provides grid projection - * functionality over the whole grid (instead os a subgroup of nodes). + * functionality over the whole grid (instead of a subgroup of nodes). * <p> * In addition to {@link ClusterGroup} functionality, from here you can get the following: * <ul> @@ -159,7 +159,7 @@ public interface Ignite extends AutoCloseable { * Creates new {@link ExecutorService} which will execute all submitted * {@link java.util.concurrent.Callable} and {@link Runnable} jobs on nodes in this grid projection. * This essentially - * creates a <b><i>Distributed Thread Pool</i</b> that can be used as a + * creates a <b><i>Distributed Thread Pool</i></b> that can be used as a * replacement for local thread pools. * * @return Grid-enabled {@code ExecutorService}. http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/cefc8855/modules/core/src/main/java/org/apache/ignite/configuration/QueryConfiguration.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/configuration/QueryConfiguration.java b/modules/core/src/main/java/org/apache/ignite/configuration/QueryConfiguration.java index 98b0f6f..2aba025 100644 --- a/modules/core/src/main/java/org/apache/ignite/configuration/QueryConfiguration.java +++ b/modules/core/src/main/java/org/apache/ignite/configuration/QueryConfiguration.java @@ -76,7 +76,11 @@ public class QueryConfiguration { this.maxOffHeapMemory = maxOffHeapMemory; } - /** {@inheritDoc} */ + /** + * Gets maximum amount of memory available to off-heap storage. + * + * @return Maximum memory in bytes available to off-heap memory space. + */ public long getMaxOffHeapMemory() { return maxOffHeapMemory; } @@ -103,12 +107,20 @@ public class QueryConfiguration { this.searchPath = searchPath; } - /** {@inheritDoc} */ + /** + * Gets the optional search path consisting of space names to search SQL schema objects. + * + * @return Search path. + */ @Nullable public String[] getSearchPath() { return searchPath; } - /** {@inheritDoc} */ + /** + * Gets script path to be ran against H2 database after opening. + * + * @return Script path. + */ @Nullable public String getInitialScriptPath() { return initScriptPath; } @@ -133,12 +145,21 @@ public class QueryConfiguration { this.idxCustomFuncClss = idxCustomFuncClss; } - /** {@inheritDoc} */ + /** + * Gets classes with methods annotated by {@link QuerySqlFunction} + * to be used as user-defined functions from SQL queries. + * + * @return List of classes. + */ @Nullable public Class<?>[] getIndexCustomFunctionClasses() { return idxCustomFuncClss; } - /** {@inheritDoc} */ + /** + * Get long query execution time timeout. + * + * @return Long query execution timeout. + */ public long getLongQueryExecutionTimeout() { return longQryExecTimeout; } @@ -157,7 +178,11 @@ public class QueryConfiguration { this.longQryExecTimeout = longQryExecTimeout; } - /** {@inheritDoc} */ + /** + * Gets flag marking SPI should print SQL execution plan for long queries (explain SQL query). + * + * @return Flag marking SPI should print SQL execution plan for long queries (explain SQL query). + */ public boolean isLongQueryExplain() { return longQryExplain; }
