Merge pull request #188 from mapbox/checkstyle-fixes-round-1

Fixed commons package content

Author: Cameron Mace

CONTRIBUTING.md

@@ -10,6 +10,8 @@ If you want to contribute code:
 
 3. Pull requests are gladly accepted. If there are any changes that developers should be aware of, please update the [change log](CHANGELOG.md)
 
+4. Mapbox uses checkstyle to enforce good Java code standards, Make sure to read the [wiki entry](https://github.com/mapbox/mapbox-java/wiki/Setting-up-Mapbox-checkstyle) and setup. CI will fail if your PR contains any mistakes. 
+
 # Code of conduct
 Everyone is invited to participate in Mapbox’s open source projects and public discussions: we want to create a welcoming and friendly environment. Harassment of participants or other unethical and unprofessional behavior will not be tolerated in our spaces. The [Contributor Covenant](http://contributor-covenant.org) applies to all projects under the Mapbox organization and we ask that you please read [the full text](http://contributor-covenant.org/version/1/2/0/).
 

libjava/lib/src/main/java/com/mapbox/services/commons/MapboxBuilder.java

@@ -7,31 +7,31 @@
  */
 public abstract class MapboxBuilder {
 
-    public abstract MapboxBuilder setAccessToken(String accessToken);
+  public abstract MapboxBuilder setAccessToken(String accessToken);
 
-    public abstract String getAccessToken();
+  public abstract String getAccessToken();
 
-    /**
-     * Method to validate a Mapbox Access token.
-     *
-     * @param accessToken A string containing a Mapbox Access Token
-     * @throws ServicesException Generic Exception for all things Mapbox.
-     * @since 1.0.0
-     */
-    protected void validateAccessToken(String accessToken) throws ServicesException {
-        if (!MapboxUtils.isAccessTokenValid(accessToken)) {
-            throw new ServicesException(
-                    "Using Mapbox Services requires setting a valid access token.");
-        }
+  /**
+   * Method to validate a Mapbox Access token.
+   *
+   * @param accessToken A string containing a Mapbox Access Token
+   * @throws ServicesException Generic Exception for all things Mapbox.
+   * @since 1.0.0
+   */
+  protected void validateAccessToken(String accessToken) throws ServicesException {
+    if (!MapboxUtils.isAccessTokenValid(accessToken)) {
+      throw new ServicesException(
+        "Using Mapbox Services requires setting a valid access token.");
     }
+  }
 
-    /**
-     * The builder.
-     *
-     * @return {@link MapboxBuilder}
-     * @throws ServicesException Generic Exception for all things Mapbox.
-     * @since 1.0.0
-     */
-    public abstract Object build() throws ServicesException;
+  /**
+   * The builder.
+   *
+   * @return {@link MapboxBuilder}
+   * @throws ServicesException Generic Exception for all things Mapbox.
+   * @since 1.0.0
+   */
+  public abstract Object build() throws ServicesException;
 
 }

libjava/lib/src/main/java/com/mapbox/services/commons/MapboxService.java

@@ -20,66 +20,66 @@
  */
 public abstract class MapboxService<T> {
 
-    private boolean enableDebug = false;
+  private boolean enableDebug = false;
 
-    public abstract Response<T> executeCall() throws IOException;
+  public abstract Response<T> executeCall() throws IOException;
 
-    public abstract void enqueueCall(Callback<T> callback);
+  public abstract void enqueueCall(Callback<T> callback);
 
-    public abstract void cancelCall();
+  public abstract void cancelCall();
 
-    public abstract Call<T> cloneCall();
+  public abstract Call<T> cloneCall();
 
-    public boolean isEnableDebug() {
-        return enableDebug;
-    }
+  public boolean isEnableDebug() {
+    return enableDebug;
+  }
 
-    public void setEnableDebug(boolean enableDebug) {
-        this.enableDebug = enableDebug;
-    }
+  public void setEnableDebug(boolean enableDebug) {
+    this.enableDebug = enableDebug;
+  }
 
-    /**
-     * Used Internally.
-     *
-     * @return OkHttpClient
-     * @since 1.0.0
-     */
-    public OkHttpClient getOkHttpClient() {
-        if (isEnableDebug()) {
-            HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
-            logging.setLevel(HttpLoggingInterceptor.Level.BASIC);
-            OkHttpClient.Builder httpClient = new OkHttpClient.Builder();
-            httpClient.addInterceptor(logging);
-            return httpClient.build();
-        } else {
-            return new OkHttpClient();
-        }
+  /**
+   * Used Internally.
+   *
+   * @return OkHttpClient
+   * @since 1.0.0
+   */
+  public OkHttpClient getOkHttpClient() {
+    if (isEnableDebug()) {
+      HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
+      logging.setLevel(HttpLoggingInterceptor.Level.BASIC);
+      OkHttpClient.Builder httpClient = new OkHttpClient.Builder();
+      httpClient.addInterceptor(logging);
+      return httpClient.build();
+    } else {
+      return new OkHttpClient();
     }
+  }
 
-    /**
-     * Computes a full user agent header of the form: MapboxJava/1.2.0 Mac OS X/10.11.5 (x86_64)
-     *
-     * @return {@link String}
-     * @since 1.0.0
-     */
-    public static String getHeaderUserAgent() {
-        String osName;
-        String osVersion;
-        String osArch;
+  /**
+   * Computes a full user agent header of the form: MapboxJava/1.2.0 Mac OS X/10.11.5 (x86_64)
+   *
+   * @return {@link String}
+   * @since 1.0.0
+   */
+  public static String getHeaderUserAgent() {
+    String osName;
+    String osVersion;
+    String osArch;
 
-        try {
-            osName = System.getProperty("os.name");
-            osVersion = System.getProperty("os.version");
-            osArch = System.getProperty("os.arch");
-        } catch (Exception e) {
-            return Constants.HEADER_USER_AGENT;
-        }
+    try {
+      osName = System.getProperty("os.name");
+      osVersion = System.getProperty("os.version");
+      osArch = System.getProperty("os.arch");
+    } catch (Exception exception) {
+      return Constants.HEADER_USER_AGENT;
+    }
 
-        if (TextUtils.isEmpty(osName) || TextUtils.isEmpty(osVersion) || TextUtils.isEmpty(osArch)) {
-            return Constants.HEADER_USER_AGENT;
-        } else {
-            String osInfo = String.format(Locale.US, "%s/%s (%s)", osName, osVersion, osArch);
-            return String.format(Locale.US, "%s %s", Constants.HEADER_USER_AGENT, osInfo);
-        }
+    if (TextUtils.isEmpty(osName) || TextUtils.isEmpty(osVersion) || TextUtils.isEmpty(osArch)) {
+      return Constants.HEADER_USER_AGENT;
+    } else {
+      String osInfo = String.format(Locale.US, "%s/%s (%s)", osName, osVersion, osArch);
+      return String.format(Locale.US, "%s %s", Constants.HEADER_USER_AGENT, osInfo);
     }
+  }
 }

libjava/lib/src/main/java/com/mapbox/services/commons/ServicesException.java

@@ -6,15 +6,15 @@
  */
 public class ServicesException extends Exception {
 
-    /**
-     * A form of {@code Throwable} that indicates conditions that a reasonable application might
-     * want to catch.
-     *
-     * @param message the detail message (which is saved for later retrieval by the
-     *                {@link #getMessage()} method).
-     * @since 1.0.0
-     */
-    public ServicesException(String message) {
-        super(message);
-    }
+  /**
+   * A form of {@code Throwable} that indicates conditions that a reasonable application might
+   * want to catch.
+   *
+   * @param message the detail message (which is saved for later retrieval by the
+   *                {@link #getMessage()} method).
+   * @since 1.0.0
+   */
+  public ServicesException(String message) {
+    super(message);
+  }
 }

libjava/lib/src/main/java/com/mapbox/services/commons/geojson/BaseFeatureCollection.java

@@ -13,44 +13,44 @@
  */
 public class BaseFeatureCollection implements GeoJSON {
 
-    private final String type = "FeatureCollection";
+  private final String type = "FeatureCollection";
 
-    /**
-     * Should always be "FeatureCollection".
-     *
-     * @return String "FeatureCollection".
-     * @since 1.0.0
-     */
-    @Override
-    public String getType() {
-        return type;
-    }
+  /**
+   * Should always be "FeatureCollection".
+   *
+   * @return String "FeatureCollection".
+   * @since 1.0.0
+   */
+  @Override
+  public String getType() {
+    return type;
+  }
 
-    /**
-     * Create a GeoJSON feature collection object from JSON.
-     *
-     * @param json String of JSON making up a feature collection.
-     * @return {@link FeatureCollection} GeoJSON object.
-     * @since 1.0.0
-     */
-    public static FeatureCollection fromJson(String json) {
-        GsonBuilder gson = new GsonBuilder();
-        gson.registerTypeAdapter(Position.class, new PositionDeserializer());
-        gson.registerTypeAdapter(Geometry.class, new GeometryDeserializer());
-        return gson.create().fromJson(json, FeatureCollection.class);
-    }
+  /**
+   * Create a GeoJSON feature collection object from JSON.
+   *
+   * @param json String of JSON making up a feature collection.
+   * @return {@link FeatureCollection} GeoJSON object.
+   * @since 1.0.0
+   */
+  public static FeatureCollection fromJson(String json) {
+    GsonBuilder gson = new GsonBuilder();
+    gson.registerTypeAdapter(Position.class, new PositionDeserializer());
+    gson.registerTypeAdapter(Geometry.class, new GeometryDeserializer());
+    return gson.create().fromJson(json, FeatureCollection.class);
+  }
 
-    /**
-     * Convert feature collection into JSON.
-     *
-     * @return String containing feature collection JSON.
-     * @since 1.0.0
-     */
-    @Override
-    public String toJson() {
-        GsonBuilder gson = new GsonBuilder();
-        gson.registerTypeAdapter(Position.class, new PositionSerializer());
-        return gson.create().toJson(this);
-    }
+  /**
+   * Convert feature collection into JSON.
+   *
+   * @return String containing feature collection JSON.
+   * @since 1.0.0
+   */
+  @Override
+  public String toJson() {
+    GsonBuilder gson = new GsonBuilder();
+    gson.registerTypeAdapter(Position.class, new PositionSerializer());
+    return gson.create().toJson(this);
+  }
 
 }