You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@orc.apache.org by om...@apache.org on 2018/05/14 21:28:53 UTC

orc git commit: ORC-364. Minor fixups on javadoc.

Repository: orc
Updated Branches:
  refs/heads/master 2bca71754 -> 4f1e5ddec


ORC-364. Minor fixups on javadoc.

Fixes #267

Signed-off-by: Owen O'Malley <om...@apache.org>


Project: http://git-wip-us.apache.org/repos/asf/orc/repo
Commit: http://git-wip-us.apache.org/repos/asf/orc/commit/4f1e5dde
Tree: http://git-wip-us.apache.org/repos/asf/orc/tree/4f1e5dde
Diff: http://git-wip-us.apache.org/repos/asf/orc/diff/4f1e5dde

Branch: refs/heads/master
Commit: 4f1e5ddecb161eb6d242e522e1f5fc8b0017e924
Parents: 2bca717
Author: Owen O'Malley <om...@apache.org>
Authored: Mon May 14 14:00:59 2018 -0700
Committer: Owen O'Malley <om...@apache.org>
Committed: Mon May 14 14:28:33 2018 -0700

----------------------------------------------------------------------
 .../java/org/apache/orc/TypeDescription.java    |  2 +-
 .../apache/orc/impl/mask/SHA256MaskFactory.java | 22 +++++++++++++-------
 .../java/org/apache/orc/impl/HadoopShims.java   |  2 +-
 .../org/apache/orc/tools/convert/CsvReader.java |  1 -
 4 files changed, 16 insertions(+), 11 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/orc/blob/4f1e5dde/java/core/src/java/org/apache/orc/TypeDescription.java
----------------------------------------------------------------------
diff --git a/java/core/src/java/org/apache/orc/TypeDescription.java b/java/core/src/java/org/apache/orc/TypeDescription.java
index 50cd022..a6affd1 100644
--- a/java/core/src/java/org/apache/orc/TypeDescription.java
+++ b/java/core/src/java/org/apache/orc/TypeDescription.java
@@ -705,7 +705,7 @@ public class TypeDescription
 
   /**
    * Create a VectorizedRowBatch that uses Decimal64ColumnVector for
-   * short (p <= 18) decimals.
+   * short (p &le; 18) decimals.
    * @return a new VectorizedRowBatch
    */
   public VectorizedRowBatch createRowBatchV2() {

http://git-wip-us.apache.org/repos/asf/orc/blob/4f1e5dde/java/core/src/java/org/apache/orc/impl/mask/SHA256MaskFactory.java
----------------------------------------------------------------------
diff --git a/java/core/src/java/org/apache/orc/impl/mask/SHA256MaskFactory.java b/java/core/src/java/org/apache/orc/impl/mask/SHA256MaskFactory.java
index 062f957..c300500 100644
--- a/java/core/src/java/org/apache/orc/impl/mask/SHA256MaskFactory.java
+++ b/java/core/src/java/org/apache/orc/impl/mask/SHA256MaskFactory.java
@@ -30,29 +30,35 @@ import java.security.NoSuchAlgorithmException;
 import java.util.Arrays;
 
 /**
+ * <p>
  * Masking strategy that masks String, Varchar, Char and Binary types
  * as SHA 256 hash.
+ * </p>
  * <p>
- * <b>For String type:</b><br/>
+ * <b>For String type:</b>
  * All string type of any length will be converted to 64 character length
- * SHA256 hash encoded in hexadecimal.<br/><br/>
+ * SHA256 hash encoded in hexadecimal.
+ * </p>
  * <p>
- * <b>For Varchar type:</b><br/>
+ * <b>For Varchar type:</b>
  * For Varchar type, max-length property will be honored i.e.
  * if the length is less than max-length then the SHA256 hash will be truncated
  * to max-length. If max-length is greater than 64 then the output is the
- * sha256 length, which is 64.<br/><br/>
+ * sha256 length, which is 64.
+ * </p>
  * <p>
- * <b>For Char type:</b><br/>
+ * <b>For Char type:</b>
  * For Char type, the length of mask will always be equal to specified
  * max-length. If the given length (max-length) is less than SHA256 hash
  * length (64) the mask will be truncated.
  * If the given length (max-length) is greater than SHA256 hash length (64)
- * then the mask will be padded by blank spaces.<br/><br/>
+ * then the mask will be padded by blank spaces.
+ * </p>
  * <p>
- * <b>For Binary type:</b><br/>
+ * <b>For Binary type:</b>
  * All Binary type of any length will be converted to 32 byte length SHA256
- * hash.<br/>
+ * hash.
+ * </p>
  */
 public class SHA256MaskFactory extends MaskFactory {
 

http://git-wip-us.apache.org/repos/asf/orc/blob/4f1e5dde/java/shims/src/java/org/apache/orc/impl/HadoopShims.java
----------------------------------------------------------------------
diff --git a/java/shims/src/java/org/apache/orc/impl/HadoopShims.java b/java/shims/src/java/org/apache/orc/impl/HadoopShims.java
index cdc43ac..a2093c6 100644
--- a/java/shims/src/java/org/apache/orc/impl/HadoopShims.java
+++ b/java/shims/src/java/org/apache/orc/impl/HadoopShims.java
@@ -117,7 +117,7 @@ public interface HadoopShims {
 
   /**
    * End the OutputStream's current block at the current location.
-   * This is only available on HDFS on Hadoop >= 2.7, but will return false
+   * This is only available on HDFS on Hadoop &ge; 2.7, but will return false
    * otherwise.
    * @return was a variable length block created?
    */

http://git-wip-us.apache.org/repos/asf/orc/blob/4f1e5dde/java/tools/src/java/org/apache/orc/tools/convert/CsvReader.java
----------------------------------------------------------------------
diff --git a/java/tools/src/java/org/apache/orc/tools/convert/CsvReader.java b/java/tools/src/java/org/apache/orc/tools/convert/CsvReader.java
index 6dbdf30..6644150 100644
--- a/java/tools/src/java/org/apache/orc/tools/convert/CsvReader.java
+++ b/java/tools/src/java/org/apache/orc/tools/convert/CsvReader.java
@@ -63,7 +63,6 @@ public class CsvReader implements RecordReader {
    * @param escapeChar the escape character
    * @param headerLines the number of header lines
    * @param nullString the string that is translated to null
-   * @throws IOException
    */
   public CsvReader(java.io.Reader reader,
                    FSDataInputStream input,