From 34c7b018febec25f3cb75e587bccee9b1a340413 Mon Sep 17 00:00:00 2001 From: proflin Date: Sun, 10 Jan 2016 14:02:30 +0800 Subject: [PATCH] Minor: Fix the mismatch of the parameters and their doc comments in module encoding, column, and hadoop --- .../org/apache/parquet/column/page/DataPageV1.java | 4 ++-- .../apache/parquet/column/values/ValuesWriter.java | 14 +++++++------- .../values/plain/BooleanPlainValuesReader.java | 4 ++-- .../org/apache/parquet/schema/TypeConverter.java | 2 +- .../column/values/bitpacking/BitPacking.java | 2 +- .../hadoop/example/ExampleOutputFormat.java | 6 +++--- .../parquet/hadoop/metadata/ParquetMetadata.java | 1 - 7 files changed, 16 insertions(+), 17 deletions(-) mode change 100644 => 100755 parquet-column/src/main/java/org/apache/parquet/column/page/DataPageV1.java mode change 100644 => 100755 parquet-column/src/main/java/org/apache/parquet/column/values/ValuesWriter.java mode change 100644 => 100755 parquet-column/src/main/java/org/apache/parquet/column/values/plain/BooleanPlainValuesReader.java mode change 100644 => 100755 parquet-column/src/main/java/org/apache/parquet/schema/TypeConverter.java mode change 100644 => 100755 parquet-encoding/src/main/java/org/apache/parquet/column/values/bitpacking/BitPacking.java mode change 100644 => 100755 parquet-hadoop/src/main/java/org/apache/parquet/hadoop/example/ExampleOutputFormat.java mode change 100644 => 100755 parquet-hadoop/src/main/java/org/apache/parquet/hadoop/metadata/ParquetMetadata.java diff --git a/parquet-column/src/main/java/org/apache/parquet/column/page/DataPageV1.java b/parquet-column/src/main/java/org/apache/parquet/column/page/DataPageV1.java old mode 100644 new mode 100755 index 22065178b4..6fbfe0caf7 --- a/parquet-column/src/main/java/org/apache/parquet/column/page/DataPageV1.java +++ b/parquet-column/src/main/java/org/apache/parquet/column/page/DataPageV1.java @@ -41,10 +41,10 @@ public class DataPageV1 extends DataPage { * @param valuesEncoding the values encoding for this page * @param dlEncoding */ - public DataPageV1(BytesInput bytes, int valueCount, int uncompressedSize, Statistics stats, Encoding rlEncoding, Encoding dlEncoding, Encoding valuesEncoding) { + public DataPageV1(BytesInput bytes, int valueCount, int uncompressedSize, Statistics statistics, Encoding rlEncoding, Encoding dlEncoding, Encoding valuesEncoding) { super(Ints.checkedCast(bytes.size()), uncompressedSize, valueCount); this.bytes = bytes; - this.statistics = stats; + this.statistics = statistics; this.rlEncoding = rlEncoding; this.dlEncoding = dlEncoding; this.valuesEncoding = valuesEncoding; diff --git a/parquet-column/src/main/java/org/apache/parquet/column/values/ValuesWriter.java b/parquet-column/src/main/java/org/apache/parquet/column/values/ValuesWriter.java old mode 100644 new mode 100755 index e5cf8e9441..3862b02eef --- a/parquet-column/src/main/java/org/apache/parquet/column/values/ValuesWriter.java +++ b/parquet-column/src/main/java/org/apache/parquet/column/values/ValuesWriter.java @@ -80,7 +80,7 @@ public void resetDictionary() { } /** - * ( > {@link #getBufferedMemorySize} ) + * ( > {@link #getBufferedSize} ) * @return the allocated size of the buffer */ abstract public long getAllocatedSize(); @@ -93,42 +93,42 @@ public void writeByte(int value) { } /** - * @param value the value to encode + * @param v the value to encode */ public void writeBoolean(boolean v) { throw new UnsupportedOperationException(getClass().getName()); } /** - * @param value the value to encode + * @param v the value to encode */ public void writeBytes(Binary v) { throw new UnsupportedOperationException(getClass().getName()); } /** - * @param value the value to encode + * @param v the value to encode */ public void writeInteger(int v) { throw new UnsupportedOperationException(getClass().getName()); } /** - * @param value the value to encode + * @param v the value to encode */ public void writeLong(long v) { throw new UnsupportedOperationException(getClass().getName()); } /** - * @param value the value to encode + * @param v the value to encode */ public void writeDouble(double v) { throw new UnsupportedOperationException(getClass().getName()); } /** - * @param value the value to encode + * @param v the value to encode */ public void writeFloat(float v) { throw new UnsupportedOperationException(getClass().getName()); diff --git a/parquet-column/src/main/java/org/apache/parquet/column/values/plain/BooleanPlainValuesReader.java b/parquet-column/src/main/java/org/apache/parquet/column/values/plain/BooleanPlainValuesReader.java old mode 100644 new mode 100755 index c3304907e2..a279938c69 --- a/parquet-column/src/main/java/org/apache/parquet/column/values/plain/BooleanPlainValuesReader.java +++ b/parquet-column/src/main/java/org/apache/parquet/column/values/plain/BooleanPlainValuesReader.java @@ -51,7 +51,7 @@ public boolean readBoolean() { /** * {@inheritDoc} - * @see org.apache.parquet.column.values.ValuesReader#skipBoolean() + * @see org.apache.parquet.column.values.ValuesReader#skip() */ @Override public void skip() { @@ -60,7 +60,7 @@ public void skip() { /** * {@inheritDoc} - * @see org.apache.parquet.column.values.ValuesReader#initFromPage(byte[], int) + * @see org.apache.parquet.column.values.ValuesReader#initFromPage(int valueCount, ByteBuffer page, int offset) */ @Override public void initFromPage(int valueCount, ByteBuffer in, int offset) throws IOException { diff --git a/parquet-column/src/main/java/org/apache/parquet/schema/TypeConverter.java b/parquet-column/src/main/java/org/apache/parquet/schema/TypeConverter.java old mode 100644 new mode 100755 index c22a877542..8be896fac0 --- a/parquet-column/src/main/java/org/apache/parquet/schema/TypeConverter.java +++ b/parquet-column/src/main/java/org/apache/parquet/schema/TypeConverter.java @@ -22,7 +22,7 @@ /** * to convert a MessageType tree - * @see Type#convert(TypeConverter) + * @see Type#convert(List, TypeConverter) * * @author Julien Le Dem * diff --git a/parquet-encoding/src/main/java/org/apache/parquet/column/values/bitpacking/BitPacking.java b/parquet-encoding/src/main/java/org/apache/parquet/column/values/bitpacking/BitPacking.java old mode 100644 new mode 100755 index c0acd11d80..7b557c7def --- a/parquet-encoding/src/main/java/org/apache/parquet/column/values/bitpacking/BitPacking.java +++ b/parquet-encoding/src/main/java/org/apache/parquet/column/values/bitpacking/BitPacking.java @@ -109,7 +109,7 @@ public static BitPackingWriter getBitPackingWriter(int bitLength, OutputStream o /** * * @param bitLength the width in bits of the integers to read - * @param inthe stream to read the bytes from + * @param in the stream to read the bytes from * @return the correct implementation for the width */ public static BitPackingReader createBitPackingReader(int bitLength, InputStream in, long valueCount) { diff --git a/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/example/ExampleOutputFormat.java b/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/example/ExampleOutputFormat.java old mode 100644 new mode 100755 index 08184da187..d503e0d3e0 --- a/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/example/ExampleOutputFormat.java +++ b/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/example/ExampleOutputFormat.java @@ -30,7 +30,7 @@ * An example output format * * must be provided the schema up front - * @see ExampleOutputFormat#setSchema(Configuration, MessageType) + * @see ExampleOutputFormat#setSchema(Job, MessageType) * @see GroupWriteSupport#PARQUET_EXAMPLE_SCHEMA * * @author Julien Le Dem @@ -40,8 +40,8 @@ public class ExampleOutputFormat extends ParquetOutputFormat { /** * set the schema being written to the job conf + * @param job * @param schema the schema of the data - * @param configuration the job configuration */ public static void setSchema(Job job, MessageType schema) { GroupWriteSupport.setSchema(schema, ContextUtil.getConfiguration(job)); @@ -49,7 +49,7 @@ public static void setSchema(Job job, MessageType schema) { /** * retrieve the schema from the conf - * @param configuration the job conf + * @param job * @return the schema */ public static MessageType getSchema(Job job) { diff --git a/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/metadata/ParquetMetadata.java b/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/metadata/ParquetMetadata.java old mode 100644 new mode 100755 index a645117505..cb6af54ebb --- a/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/metadata/ParquetMetadata.java +++ b/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/metadata/ParquetMetadata.java @@ -101,7 +101,6 @@ public static ParquetMetadata fromJSON(String json) { * * @param fileMetaData file level metadata * @param blocks block level metadata - * @param keyValueMetaData */ public ParquetMetadata(FileMetaData fileMetaData, List blocks) { this.fileMetaData = fileMetaData;