You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by em...@apache.org on 2019/07/10 07:02:21 UTC
[arrow] branch master updated: [Style][Java] fix typo and invalid
reference in comments (#4832)
This is an automated email from the ASF dual-hosted git repository.
emkornfield pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new 6e2d84a [Style][Java] fix typo and invalid reference in comments (#4832)
6e2d84a is described below
commit 6e2d84a6effdcaab65de45bdcc5c55914212409c
Author: tianchen92 <ni...@alibaba-inc.com>
AuthorDate: Wed Jul 10 15:02:14 2019 +0800
[Style][Java] fix typo and invalid reference in comments (#4832)
Fix typos and references in javadocs.
---
.../main/java/org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.java | 7 ++++---
.../main/java/org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.java | 2 +-
.../main/java/org/apache/arrow/memory/ValueWithKeyIncluded.java | 2 +-
.../src/main/java/org/apache/arrow/vector/AddOrGetResult.java | 2 +-
.../org/apache/arrow/vector/complex/impl/PromotableWriter.java | 2 +-
.../org/apache/arrow/vector/types/pojo/DictionaryEncoding.java | 4 ++--
6 files changed, 10 insertions(+), 9 deletions(-)
diff --git a/java/adapter/jdbc/src/main/java/org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.java b/java/adapter/jdbc/src/main/java/org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.java
index 068fd07..800db1b 100644
--- a/java/adapter/jdbc/src/main/java/org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.java
+++ b/java/adapter/jdbc/src/main/java/org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.java
@@ -28,7 +28,8 @@ import com.google.common.base.Preconditions;
* This class configures the JDBC-to-Arrow conversion process.
* <p>
* The allocator is used to construct the {@link org.apache.arrow.vector.VectorSchemaRoot},
- * and the calendar is used to define the time zone of any {@link org.apahe.arrow.vector.pojo.ArrowType.Timestamp}
+ * and the calendar is used to define the time zone of any
+ * {@link org.apache.arrow.vector.types.pojo.ArrowType.Timestamp}
* fields that are created during the conversion. Neither field may be <code>null</code>.
* </p>
* <p>
@@ -98,8 +99,8 @@ public final class JdbcToArrowConfig {
/**
* The calendar to use when defining Arrow Timestamp fields
- * and retrieving {@link Date}, {@link Time}, or {@link Timestamp}
- * data types from the {@link ResultSet}, or <code>null</code> if not converting.
+ * and retrieving {@link java.sql.Date}, {@link java.sql.Time}, or {@link java.sql.Timestamp}
+ * data types from the {@link java.sql.ResultSet}, or <code>null</code> if not converting.
*
* @return the calendar.
*/
diff --git a/java/adapter/jdbc/src/main/java/org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.java b/java/adapter/jdbc/src/main/java/org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.java
index f54363f..882198c 100644
--- a/java/adapter/jdbc/src/main/java/org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.java
+++ b/java/adapter/jdbc/src/main/java/org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.java
@@ -128,7 +128,7 @@ public class JdbcToArrowUtils {
* {@link org.apache.arrow.vector.types.pojo.ArrowType} for each field in the {@link java.sql.ResultSetMetaData}.
* </p>
* <p>
- * If {@link JdbcToArrowConfig#getIncludeMetadata()} returns <code>true</code>, the following fields
+ * If {@link JdbcToArrowConfig#shouldIncludeMetadata()} returns <code>true</code>, the following fields
* will be added to the {@link FieldType#getMetadata()}:
* <ul>
* <li>{@link Constants#SQL_CATALOG_NAME_KEY} representing {@link ResultSetMetaData#getCatalogName(int)}</li>
diff --git a/java/memory/src/main/java/org/apache/arrow/memory/ValueWithKeyIncluded.java b/java/memory/src/main/java/org/apache/arrow/memory/ValueWithKeyIncluded.java
index cb23c2e..2699b6a 100644
--- a/java/memory/src/main/java/org/apache/arrow/memory/ValueWithKeyIncluded.java
+++ b/java/memory/src/main/java/org/apache/arrow/memory/ValueWithKeyIncluded.java
@@ -18,7 +18,7 @@
package org.apache.arrow.memory;
/**
- * Helper Iface to generify a value to be included in the map where
+ * Helper interface to generify a value to be included in the map where
* key is part of the value.
*
* @param <K> The type of the key.
diff --git a/java/vector/src/main/java/org/apache/arrow/vector/AddOrGetResult.java b/java/vector/src/main/java/org/apache/arrow/vector/AddOrGetResult.java
index 30aadfb..b41dbb2 100644
--- a/java/vector/src/main/java/org/apache/arrow/vector/AddOrGetResult.java
+++ b/java/vector/src/main/java/org/apache/arrow/vector/AddOrGetResult.java
@@ -39,7 +39,7 @@ public class AddOrGetResult<V extends ValueVector> {
return vector;
}
- /** Returns whether the vectos is created. */
+ /** Returns whether the vector is created. */
public boolean isCreated() {
return created;
}
diff --git a/java/vector/src/main/java/org/apache/arrow/vector/complex/impl/PromotableWriter.java b/java/vector/src/main/java/org/apache/arrow/vector/complex/impl/PromotableWriter.java
index ce3948c..9009040 100644
--- a/java/vector/src/main/java/org/apache/arrow/vector/complex/impl/PromotableWriter.java
+++ b/java/vector/src/main/java/org/apache/arrow/vector/complex/impl/PromotableWriter.java
@@ -42,7 +42,7 @@ import io.netty.buffer.ArrowBuf;
* specifically typed writer cannot handle. A new UnionVector is created, wrapping the original vector, and replaces the
* original vector in the parent vector, which can be either an AbstractStructVector or a ListVector.
*
- * <p>The writer used can either be for single elements (struct) or lists.</p>
+ * <p>The writer used can either be for single elements (struct) or lists.</p>
*/
public class PromotableWriter extends AbstractPromotableFieldWriter {
diff --git a/java/vector/src/main/java/org/apache/arrow/vector/types/pojo/DictionaryEncoding.java b/java/vector/src/main/java/org/apache/arrow/vector/types/pojo/DictionaryEncoding.java
index 2bbb52d..8d41b92 100644
--- a/java/vector/src/main/java/org/apache/arrow/vector/types/pojo/DictionaryEncoding.java
+++ b/java/vector/src/main/java/org/apache/arrow/vector/types/pojo/DictionaryEncoding.java
@@ -37,9 +37,9 @@ public class DictionaryEncoding {
/**
* Constructs a new instance.
*
- * @param id The ID of the dictionary to use for iecnoding.
+ * @param id The ID of the dictionary to use for encoding.
* @param ordered Whether the keys in values in the dictionary are ordered.
- * @param indexType (nullable). The integer type to use for indexing in the dictionary. Defaults to a signed
+ * @param indexType (nullable). The integer type to use for indexing in the dictionary. Defaults to a signed
* 32 bit integer.
*/
@JsonCreator