# ignite-432: fix wrong {@inheritDoc} links
Project: http://git-wip-us.apache.org/repos/asf/incubator-ignite/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-ignite/commit/4dc826cb
Tree: http://git-wip-us.apache.org/repos/asf/incubator-ignite/tree/4dc826cb
Diff: http://git-wip-us.apache.org/repos/asf/incubator-ignite/diff/4dc826cb
Branch: refs/heads/ignite-375
Commit: 4dc826cb92ac239d37ea5c00af5c56b99cf9c83f
Parents: bc337f5
Author: Artem Shutak <ashu...@gridgain.com>
Authored: Tue Mar 17 18:11:45 2015 +0300
Committer: Artem Shutak <ashu...@gridgain.com>
Committed: Tue Mar 17 18:11:45 2015 +0300
----------------------------------------------------------------------
.../tests/p2p/GridExternalAffinityFunction.java | 8 +++-
.../processors/query/h2/IgniteH2Indexing.java | 43 +++++++++++++++++---
.../processors/query/h2/sql/GridSqlElement.java | 6 ++-
3 files changed, 49 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/4dc826cb/modules/extdata/p2p/src/main/java/org/apache/ignite/tests/p2p/GridExternalAffinityFunction.java
----------------------------------------------------------------------
diff --git
a/modules/extdata/p2p/src/main/java/org/apache/ignite/tests/p2p/GridExternalAffinityFunction.java
b/modules/extdata/p2p/src/main/java/org/apache/ignite/tests/p2p/GridExternalAffinityFunction.java
index fced1aa..543e779 100644
---
a/modules/extdata/p2p/src/main/java/org/apache/ignite/tests/p2p/GridExternalAffinityFunction.java
+++
b/modules/extdata/p2p/src/main/java/org/apache/ignite/tests/p2p/GridExternalAffinityFunction.java
@@ -73,7 +73,13 @@ public class GridExternalAffinityFunction implements
CacheAffinityFunction {
return res;
}
- /** {@inheritDoc} */
+ /**
+ * Assigns nodes to one partition.
+ *
+ * @param part Partition to assign nodes for.
+ * @param nodes Cache topology nodes.
+ * @return Assigned nodes, first node is primary, others are backups.
+ */
public Collection<ClusterNode> nodes(int part, Collection<ClusterNode>
nodes) {
List<ClusterNode> sorted = new ArrayList<>(nodes);
http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/4dc826cb/modules/indexing/src/main/java/org/apache/ignite/internal/processors/query/h2/IgniteH2Indexing.java
----------------------------------------------------------------------
diff --git
a/modules/indexing/src/main/java/org/apache/ignite/internal/processors/query/h2/IgniteH2Indexing.java
b/modules/indexing/src/main/java/org/apache/ignite/internal/processors/query/h2/IgniteH2Indexing.java
index 180ccb5..5d24eea 100644
---
a/modules/indexing/src/main/java/org/apache/ignite/internal/processors/query/h2/IgniteH2Indexing.java
+++
b/modules/indexing/src/main/java/org/apache/ignite/internal/processors/query/h2/IgniteH2Indexing.java
@@ -18,7 +18,6 @@
package org.apache.ignite.internal.processors.query.h2;
import org.apache.ignite.*;
-import org.apache.ignite.cache.*;
import org.apache.ignite.cache.query.annotations.*;
import org.apache.ignite.configuration.*;
import org.apache.ignite.internal.*;
@@ -1417,14 +1416,34 @@ public class IgniteH2Indexing implements
GridQueryIndexing {
return cfg != null && cfg.isIndexPrimitiveValue();
}
- /** {@inheritDoc} */
+ /**
+ * If {@code false}, SPI will store all keys in BINARY form to make it
possible to store
+ * the same value type with different key types. If {@code true}, key type
will be converted
+ * to respective SQL type if it is possible.
+ * <p>
+ * Setting this value to {@code false} also means that {@code '_key'}
column cannot be indexed and
+ * cannot participate in query where clauses. The behavior of using '_key'
column in where
+ * clauses with this flag set to {@code false} is undefined.
+ *
+ * @param spaceName Space name.
+ * @return Flag value.
+ */
public boolean isIndexFixedTyping(String spaceName) {
CacheQueryConfiguration cfg = cacheQueryConfiguration(spaceName);
return cfg != null && cfg.isIndexFixedTyping();
}
- /** {@inheritDoc} */
+ /**
+ * If {@code true}, then table name and all column names in 'create table'
SQL
+ * generated by SPI are escaped with double quotes. This flag should be
set if table name of
+ * column name is H2 reserved word or is not valid H2 identifier (e.g.
contains space or hyphen).
+ * <p>
+ * Note if this flag is set then table and column name in SQL queries also
must be escaped with double quotes.
+ *
+ * @param spaceName Space name.
+ * @return Flag value.
+ */
public boolean isEscapeAll(String spaceName) {
CacheQueryConfiguration cfg = cacheQueryConfiguration(spaceName);
@@ -1439,17 +1458,29 @@ public class IgniteH2Indexing implements
GridQueryIndexing {
return ctx == null ? null :
ctx.cache().internalCache(spaceName).configuration().getQueryConfiguration();
}
- /** {@inheritDoc} */
+ /**
+ * Gets maximum allowed off-heap rows cache size in items.
+ *
+ * @return Maximum allowed off-heap rows cache size.
+ */
public int getMaxOffheapRowsCacheSize() {
return (int)rowCache.getMaxMemory();
}
- /** {@inheritDoc} */
+ /**
+ * Gets current off-heap rows cache size in items.
+ *
+ * @return Current off-heap rows cache size.
+ */
public int getOffheapRowsCacheSize() {
return (int)rowCache.getUsedMemory();
}
- /** {@inheritDoc} */
+ /**
+ * Gets currently allocated offheap memory.
+ *
+ * @return Allocated memory in bytes.
+ */
public long getAllocatedOffHeapMemory() {
return offheap == null ? -1 : offheap.allocatedSize();
}
http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/4dc826cb/modules/indexing/src/main/java/org/apache/ignite/internal/processors/query/h2/sql/GridSqlElement.java
----------------------------------------------------------------------
diff --git
a/modules/indexing/src/main/java/org/apache/ignite/internal/processors/query/h2/sql/GridSqlElement.java
b/modules/indexing/src/main/java/org/apache/ignite/internal/processors/query/h2/sql/GridSqlElement.java
index 5096935..82cd8fb 100644
---
a/modules/indexing/src/main/java/org/apache/ignite/internal/processors/query/h2/sql/GridSqlElement.java
+++
b/modules/indexing/src/main/java/org/apache/ignite/internal/processors/query/h2/sql/GridSqlElement.java
@@ -26,7 +26,11 @@ public abstract class GridSqlElement implements Cloneable {
/** */
protected List<GridSqlElement> children = new ArrayList<>();
- /** {@inheritDoc} */
+ /**
+ * Get the SQL expression.
+ *
+ * @return the SQL expression.
+ */
public abstract String getSQL();
/**
