#14: Fixed Javadoc warnings and reproducible build issues (#16)

exasol · Jun 2, 2021 · ef4d13d · ef4d13d
1 parent 98f3542
commit ef4d13d
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 15 deletions.
diff --git a/doc/changes/changes_1.0.0.md b/doc/changes/changes_1.0.0.md
@@ -17,6 +17,10 @@ A Java library to read Parquet files that we extracted into its own repository.
 * #6: Fixed dependency vulnerability and broken links.
 * #11: Updated Scala library to `2.12.14` version.
 
+## Bug
+
+* #14: Fixed Javadoc warnings and reordered plugins.
+
 ## Dependency Updates
 
 ### Compile Dependency Updates

diff --git a/pom.xml b/pom.xml
@@ -377,20 +377,6 @@
                     <reportShowOrigin>true</reportShowOrigin>
                 </configuration>
             </plugin>
-            <plugin>
-                <groupId>io.github.zlika</groupId>
-                <artifactId>reproducible-build-maven-plugin</artifactId>
-                <version>0.13</version>
-                <executions>
-                    <execution>
-                        <id>strip-jar</id>
-                        <phase>package</phase>
-                        <goals>
-                            <goal>strip-jar</goal>
-                        </goals>
-                    </execution>
-                </executions>
-            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-failsafe-plugin</artifactId>
@@ -494,9 +480,23 @@
                     <serialwarn>true</serialwarn>
                     <failOnError>true</failOnError>
                     <failOnWarnings>true</failOnWarnings>
-                    <sourcepath>${project.basedir}/src/main/scala</sourcepath>
+                    <sourcepath>${project.basedir}/src/main/java</sourcepath>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>io.github.zlika</groupId>
+                <artifactId>reproducible-build-maven-plugin</artifactId>
+                <version>0.13</version>
+                <executions>
+                    <execution>
+                        <id>strip-jar</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>strip-jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
         <pluginManagement>
             <plugins>

diff --git a/src/main/java/com/exasol/parquetio/data/GenericRow.java b/src/main/java/com/exasol/parquetio/data/GenericRow.java
@@ -38,6 +38,7 @@ public GenericRow(final MessageType schema, final List<Object> values) {
      * A factory method to create a new instance.
      *
      * @param values list of values
+     * @return an instance of {@link GenericRow}
      */
     public static GenericRow of(final Object... values) {
         return new GenericRow(Arrays.asList(values));
@@ -48,6 +49,7 @@ public static GenericRow of(final Object... values) {
      *
      * @param schema schema of a row
      * @param values list of values
+     * @return an instance of {@link GenericRow}
      */
     public static GenericRow of(final MessageType schema, final Object... values) {
         return new GenericRow(schema, Arrays.asList(values));

diff --git a/src/main/java/com/exasol/parquetio/reader/RowParquetReader.java b/src/main/java/com/exasol/parquetio/reader/RowParquetReader.java
@@ -23,6 +23,7 @@ private RowParquetReader() {
     /**
      * Creates a new builder for {@link RowParquetReader}.
      *
+     * @param file input file to read from
      * @return new {@link Builder}
      */
     public static Builder builder(final InputFile file) {
@@ -35,6 +36,8 @@ public static Builder builder(final InputFile file) {
     public static class Builder extends ParquetReader.Builder<Row> {
         /**
          * A constructor for the builder of {@link RowParquetReader}.
+         *
+         * @param file input file to read from
          */
         protected Builder(final InputFile file) {
             super(file);
@@ -51,6 +54,7 @@ protected ReadSupport<Row> getReadSupport() {
      *
      * @param file an input file
      * @return Parquet file schema
+     * @throws IOException if it cannot open the file for reading
      */
     public static MessageType getSchema(InputFile file) throws IOException {
         try (final var reader = ParquetFileReader.open(file)) {