Skip to content

Commit 34c7b01

Browse files
committed
Minor: Fix the mismatch of the parameters and their doc comments in module encoding, column, and hadoop
1 parent 368588b commit 34c7b01

File tree

7 files changed

+16
-17
lines changed

7 files changed

+16
-17
lines changed

parquet-column/src/main/java/org/apache/parquet/column/page/DataPageV1.java

100644100755
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ public class DataPageV1 extends DataPage {
4141
* @param valuesEncoding the values encoding for this page
4242
* @param dlEncoding
4343
*/
44-
public DataPageV1(BytesInput bytes, int valueCount, int uncompressedSize, Statistics<?> stats, Encoding rlEncoding, Encoding dlEncoding, Encoding valuesEncoding) {
44+
public DataPageV1(BytesInput bytes, int valueCount, int uncompressedSize, Statistics<?> statistics, Encoding rlEncoding, Encoding dlEncoding, Encoding valuesEncoding) {
4545
super(Ints.checkedCast(bytes.size()), uncompressedSize, valueCount);
4646
this.bytes = bytes;
47-
this.statistics = stats;
47+
this.statistics = statistics;
4848
this.rlEncoding = rlEncoding;
4949
this.dlEncoding = dlEncoding;
5050
this.valuesEncoding = valuesEncoding;

parquet-column/src/main/java/org/apache/parquet/column/values/ValuesWriter.java

100644100755
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ public void resetDictionary() {
8080
}
8181

8282
/**
83-
* ( > {@link #getBufferedMemorySize} )
83+
* ( > {@link #getBufferedSize} )
8484
* @return the allocated size of the buffer
8585
*/
8686
abstract public long getAllocatedSize();
@@ -93,42 +93,42 @@ public void writeByte(int value) {
9393
}
9494

9595
/**
96-
* @param value the value to encode
96+
* @param v the value to encode
9797
*/
9898
public void writeBoolean(boolean v) {
9999
throw new UnsupportedOperationException(getClass().getName());
100100
}
101101

102102
/**
103-
* @param value the value to encode
103+
* @param v the value to encode
104104
*/
105105
public void writeBytes(Binary v) {
106106
throw new UnsupportedOperationException(getClass().getName());
107107
}
108108

109109
/**
110-
* @param value the value to encode
110+
* @param v the value to encode
111111
*/
112112
public void writeInteger(int v) {
113113
throw new UnsupportedOperationException(getClass().getName());
114114
}
115115

116116
/**
117-
* @param value the value to encode
117+
* @param v the value to encode
118118
*/
119119
public void writeLong(long v) {
120120
throw new UnsupportedOperationException(getClass().getName());
121121
}
122122

123123
/**
124-
* @param value the value to encode
124+
* @param v the value to encode
125125
*/
126126
public void writeDouble(double v) {
127127
throw new UnsupportedOperationException(getClass().getName());
128128
}
129129

130130
/**
131-
* @param value the value to encode
131+
* @param v the value to encode
132132
*/
133133
public void writeFloat(float v) {
134134
throw new UnsupportedOperationException(getClass().getName());

parquet-column/src/main/java/org/apache/parquet/column/values/plain/BooleanPlainValuesReader.java

100644100755
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public boolean readBoolean() {
5151

5252
/**
5353
* {@inheritDoc}
54-
* @see org.apache.parquet.column.values.ValuesReader#skipBoolean()
54+
* @see org.apache.parquet.column.values.ValuesReader#skip()
5555
*/
5656
@Override
5757
public void skip() {
@@ -60,7 +60,7 @@ public void skip() {
6060

6161
/**
6262
* {@inheritDoc}
63-
* @see org.apache.parquet.column.values.ValuesReader#initFromPage(byte[], int)
63+
* @see org.apache.parquet.column.values.ValuesReader#initFromPage(int valueCount, ByteBuffer page, int offset)
6464
*/
6565
@Override
6666
public void initFromPage(int valueCount, ByteBuffer in, int offset) throws IOException {

parquet-column/src/main/java/org/apache/parquet/schema/TypeConverter.java

100644100755
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
/**
2424
* to convert a MessageType tree
25-
* @see Type#convert(TypeConverter)
25+
* @see Type#convert(List, TypeConverter)
2626
*
2727
* @author Julien Le Dem
2828
*

parquet-encoding/src/main/java/org/apache/parquet/column/values/bitpacking/BitPacking.java

100644100755
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ public static BitPackingWriter getBitPackingWriter(int bitLength, OutputStream o
109109
/**
110110
*
111111
* @param bitLength the width in bits of the integers to read
112-
* @param inthe stream to read the bytes from
112+
* @param in the stream to read the bytes from
113113
* @return the correct implementation for the width
114114
*/
115115
public static BitPackingReader createBitPackingReader(int bitLength, InputStream in, long valueCount) {

parquet-hadoop/src/main/java/org/apache/parquet/hadoop/example/ExampleOutputFormat.java

100644100755
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
* An example output format
3131
*
3232
* must be provided the schema up front
33-
* @see ExampleOutputFormat#setSchema(Configuration, MessageType)
33+
* @see ExampleOutputFormat#setSchema(Job, MessageType)
3434
* @see GroupWriteSupport#PARQUET_EXAMPLE_SCHEMA
3535
*
3636
* @author Julien Le Dem
@@ -40,16 +40,16 @@ public class ExampleOutputFormat extends ParquetOutputFormat<Group> {
4040

4141
/**
4242
* set the schema being written to the job conf
43+
* @param job
4344
* @param schema the schema of the data
44-
* @param configuration the job configuration
4545
*/
4646
public static void setSchema(Job job, MessageType schema) {
4747
GroupWriteSupport.setSchema(schema, ContextUtil.getConfiguration(job));
4848
}
4949

5050
/**
5151
* retrieve the schema from the conf
52-
* @param configuration the job conf
52+
* @param job
5353
* @return the schema
5454
*/
5555
public static MessageType getSchema(Job job) {

parquet-hadoop/src/main/java/org/apache/parquet/hadoop/metadata/ParquetMetadata.java

100644100755
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,6 @@ public static ParquetMetadata fromJSON(String json) {
101101
*
102102
* @param fileMetaData file level metadata
103103
* @param blocks block level metadata
104-
* @param keyValueMetaData
105104
*/
106105
public ParquetMetadata(FileMetaData fileMetaData, List<BlockMetaData> blocks) {
107106
this.fileMetaData = fileMetaData;

0 commit comments

Comments
 (0)