#65 add checkstyle to java apis (#67)

java/pom.xml

@@ -192,6 +192,31 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <version>3.1.1</version>
+                <executions>
+                    <execution>
+                        <id>validate</id>
+                        <phase>validate</phase>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <configLocation>src/main/resources/checkstyle.xml</configLocation>
+                    <suppressionsLocation>src/main/resources/suppressions.xml</suppressionsLocation>
+                    <failOnViolation>true</failOnViolation>
+                    <failsOnError>true</failsOnError>
+                    <consoleOutput>true</consoleOutput>
+                    <logViolationsToConsole>true</logViolationsToConsole>
+                    <sourceDirectories>
+                        <sourceDirectory>src/main/java</sourceDirectory>
+                    </sourceDirectories>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 

java/src/main/java/com/logicalclocks/hsfs/DataFormat.java

@@ -13,6 +13,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
+
 package com.logicalclocks.hsfs;
 
 import com.fasterxml.jackson.annotation.JsonProperty;

java/src/main/java/com/logicalclocks/hsfs/EntityEndpointType.java

@@ -13,6 +13,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
+
 package com.logicalclocks.hsfs;
 
 public enum EntityEndpointType {

java/src/main/java/com/logicalclocks/hsfs/Feature.java

@@ -13,6 +13,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
+
 package com.logicalclocks.hsfs;
 
 import lombok.AllArgsConstructor;

java/src/main/java/com/logicalclocks/hsfs/FeatureGroup.java

@@ -13,6 +13,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
+
 package com.logicalclocks.hsfs;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
@@ -176,9 +177,9 @@ public void delete() throws FeatureStoreException, IOException {
   }
 
   /**
-   * Add a tag without value to the feature group
+   * Add a tag without value to the feature group.
    *
-   * @param name: name of the tag
+   * @param name name of the tag
    * @throws FeatureStoreException
    * @throws IOException
    */
@@ -187,10 +188,10 @@ public void addTag(String name) throws FeatureStoreException, IOException {
   }
 
   /**
-   * Add name/value tag to the feature group
+   * Add name/value tag to the feature group.
    *
-   * @param name: name of the tag
-   * @param value: value of the tag
+   * @param name name of the tag
+   * @param value value of the tag
    * @throws FeatureStoreException
    * @throws IOException
    */
@@ -199,7 +200,7 @@ public void addTag(String name, String value) throws FeatureStoreException, IOEx
   }
 
   /**
-   * Get all tags of the feature group
+   * Get all tags of the feature group.
    *
    * @return map of all tags from name to value
    * @throws FeatureStoreException
@@ -211,9 +212,9 @@ public Map<String, String> getTag() throws FeatureStoreException, IOException {
   }
 
   /**
-   * Get a single tag value of the feature group
+   * Get a single tag value of the feature group.
    *
-   * @param name: name of tha tag
+   * @param name name of tha tag
    * @return string value of the tag
    * @throws FeatureStoreException
    * @throws IOException
@@ -224,9 +225,9 @@ public Map<String, String> getTag(String name) throws FeatureStoreException, IOE
   }
 
   /**
-   * Delete a tag of the feature group
+   * Delete a tag of the feature group.
    *
-   * @param name: name of the tag to be deleted
+   * @param name name of the tag to be deleted
    * @throws FeatureStoreException
    * @throws IOException
    */

java/src/main/java/com/logicalclocks/hsfs/FeatureStore.java

@@ -13,11 +13,10 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
+
 package com.logicalclocks.hsfs;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.google.common.base.Strings;
-import com.logicalclocks.hsfs.engine.FeatureGroupEngine;
 import com.logicalclocks.hsfs.engine.SparkEngine;
 import com.logicalclocks.hsfs.metadata.FeatureGroupApi;
 import com.logicalclocks.hsfs.metadata.StorageConnectorApi;
@@ -51,7 +50,7 @@ public class FeatureStore {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(FeatureStore.class);
 
-  final Integer DEFAULT_VERSION = 1;
+  private static final Integer DEFAULT_VERSION = 1;
 
   public FeatureStore() throws FeatureStoreException {
     featureGroupApi = new FeatureGroupApi();
@@ -60,26 +59,30 @@ public FeatureStore() throws FeatureStoreException {
   }
 
   /**
-   * Get a feature group object from the feature store
-   * @param name: the name of the feature group
-   * @param version: the version of the feature group
-   * @return
+   * Get a feature group object from the feature store.
+   *
+   * @param name the name of the feature group
+   * @param version the version of the feature group
+   * @return FeatureGroup
    * @throws FeatureStoreException
+   * @throws IOException
    */
   public FeatureGroup getFeatureGroup(@NonNull String name, @NonNull Integer version)
       throws FeatureStoreException, IOException {
     return featureGroupApi.get(this, name, version);
   }
 
   /**
-   * Get a feature group object with default version `1` from the feature store
-   * @param name: the name of the feature group
-   * @return
+   * Get a feature group object with default version `1` from the feature store.
+   *
+   * @param name the name of the feature group
+   * @return FeatureGroup
    * @throws FeatureStoreException
+   * @throws IOException
    */
   public FeatureGroup getFeatureGroup(String name) throws FeatureStoreException, IOException {
-    LOGGER.info("VersionWarning: No version provided for getting feature group `" + name + "`, defaulting to `" +
-      DEFAULT_VERSION + "`.");
+    LOGGER.info("VersionWarning: No version provided for getting feature group `" + name + "`, defaulting to `"
+        + DEFAULT_VERSION + "`.");
     return getFeatureGroup(name, DEFAULT_VERSION);
   }
 
@@ -88,7 +91,7 @@ public Dataset<Row> sql(String query) {
   }
 
   public StorageConnector getStorageConnector(String name, StorageConnectorType type)
-     throws FeatureStoreException, IOException {
+      throws FeatureStoreException, IOException {
     return storageConnectorApi.getByNameAndType(this, name, type);
   }
 
@@ -103,10 +106,11 @@ public TrainingDataset.TrainingDatasetBuilder createTrainingDataset() {
   }
 
   /**
-   * Get a training dataset object from the selected feature store
-   * @param name: name of the training dataset
-   * @param version: version to get
-   * @return
+   * Get a training dataset object from the selected feature store.
+   *
+   * @param name name of the training dataset
+   * @param version version to get
+   * @return TrainingDataset
    * @throws FeatureStoreException
    * @throws IOException
    */
@@ -116,25 +120,26 @@ public TrainingDataset getTrainingDataset(@NonNull String name, @NonNull Integer
   }
 
   /**
-   * Get a training dataset object with the default version `1` from the selected feature store
-   * @param name: name of the training dataset
-   * @return
+   * Get a training dataset object with the default version `1` from the selected feature store.
+   *
+   * @param name name of the training dataset
+   * @return TrainingDataset
    * @throws FeatureStoreException
    * @throws IOException
    */
   public TrainingDataset getTrainingDataset(String name) throws FeatureStoreException, IOException {
-    LOGGER.info("VersionWarning: No version provided for getting training dataset `" + name + "`, defaulting to `" +
-      DEFAULT_VERSION + "`.");
+    LOGGER.info("VersionWarning: No version provided for getting training dataset `" + name + "`, defaulting to `"
+        + DEFAULT_VERSION + "`.");
     return getTrainingDataset(name, DEFAULT_VERSION);
   }
 
   @Override
   public String toString() {
-    return "FeatureStore{" +
-        "id=" + id +
-        ", name='" + name + '\'' +
-        ", projectId=" + projectId +
-        ", featureGroupApi=" + featureGroupApi +
-        '}';
+    return "FeatureStore{"
+        + "id=" + id
+        + ", name='" + name + '\''
+        + ", projectId=" + projectId
+        + ", featureGroupApi=" + featureGroupApi
+        + '}';
   }
 }

java/src/main/java/com/logicalclocks/hsfs/FeatureStoreException.java

@@ -13,6 +13,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
+
 package com.logicalclocks.hsfs;
 
 public class FeatureStoreException extends Exception {

java/src/main/java/com/logicalclocks/hsfs/FsQuery.java

@@ -13,6 +13,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
+
 package com.logicalclocks.hsfs;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

java/src/main/java/com/logicalclocks/hsfs/HopsworksConnection.java

@@ -13,6 +13,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
+
 package com.logicalclocks.hsfs;
 
 import com.google.common.base.Strings;
@@ -58,7 +59,7 @@ public class HopsworksConnection implements Closeable {
   private String certPath;
 
   @Getter
-  private String APIKeyFilePath;
+  private String apiKeyFilePath;
 
 
   private FeatureStoreApi featureStoreApi = new FeatureStoreApi();
@@ -69,7 +70,7 @@ public class HopsworksConnection implements Closeable {
   @Builder
   public HopsworksConnection(String host, int port, String project, Region region, SecretStore secretStore,
                              boolean hostnameVerification, String trustStorePath,
-                             String certPath, String APIKeyFilePath) throws IOException, FeatureStoreException {
+                             String certPath, String apiKeyFilePath) throws IOException, FeatureStoreException {
     this.host = host;
     this.port = port;
     this.project = project;
@@ -78,29 +79,31 @@ public HopsworksConnection(String host, int port, String project, Region region,
     this.hostnameVerification = hostnameVerification;
     this.trustStorePath = trustStorePath;
     this.certPath = certPath;
-    this.APIKeyFilePath = APIKeyFilePath;
+    this.apiKeyFilePath = apiKeyFilePath;
 
     HopsworksClient hopsworksClient = HopsworksClient.setupHopsworksClient(host, port, region, secretStore,
-        hostnameVerification, trustStorePath, APIKeyFilePath);
+        hostnameVerification, trustStorePath, this.apiKeyFilePath);
     projectObj = getProject();
     hopsworksClient.downloadCredentials(projectObj, certPath);
   }
 
   /**
-   * Retrieve the project feature store
-   * @return
+   * Retrieve the project feature store.
+   *
+   * @return FeatureStore
    * @throws IOException
    * @throws FeatureStoreException
    */
-  public FeatureStore getFeatureStore() throws IOException, FeatureStoreException{
+  public FeatureStore getFeatureStore() throws IOException, FeatureStoreException {
     return getFeatureStore(project + Constants.FEATURESTORE_SUFFIX);
   }
 
   /**
    * Retrieve a feature store based on name. The feature store needs to be shared with
    * the connection's project.
-   * @param name
-   * @return
+   *
+   * @param name the name of the feature store to get the handle for
+   * @return FeatureStore
    * @throws IOException
    * @throws FeatureStoreException
    */

java/src/main/java/com/logicalclocks/hsfs/JoinType.java

@@ -13,6 +13,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
+
 package com.logicalclocks.hsfs;
 
 public enum JoinType {

java/src/main/java/com/logicalclocks/hsfs/MainClass.java

@@ -13,6 +13,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
+
 package com.logicalclocks.hsfs;
 
 import com.logicalclocks.hsfs.engine.SparkEngine;
@@ -26,7 +27,7 @@
 
 public class MainClass {
 
-  private final static Logger LOGGER = LoggerFactory.getLogger(MainClass.class);
+  private static final Logger LOGGER = LoggerFactory.getLogger(MainClass.class);
 
   public static void main(String[] args) throws Exception {
 

java/src/main/java/com/logicalclocks/hsfs/Project.java

@@ -13,6 +13,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
+
 package com.logicalclocks.hsfs;
 
 import lombok.Getter;

java/src/main/java/com/logicalclocks/hsfs/SecretStore.java

@@ -13,6 +13,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
+
 package com.logicalclocks.hsfs;
 
 public enum SecretStore {

java/src/main/java/com/logicalclocks/hsfs/Split.java

@@ -13,6 +13,7 @@
  *
  * See the License for the specific language governing permissions and limitations under the License.
  */
+
 package com.logicalclocks.hsfs;
 
 import lombok.AllArgsConstructor;