From 912e1bd005407f25e37bed16039743fc7c0c66a4 Mon Sep 17 00:00:00 2001
From: Hallvard Traetteberg <hal@ntnu.no>
Date: Tue, 20 Aug 2019 23:38:26 +0200
Subject: [PATCH] Fixes most google checkstyle warnings.
---
.../doc/AbstractDocumentStorageImpl.java | 22 ++++++++---------
.../java/fxutil/doc/FileMenuController.java | 24 +++++++++----------
.../java/fxutil/doc/IDocumentImporter.java | 8 +++----
.../main/java/fxutil/doc/IDocumentLoader.java | 10 ++++----
.../main/java/fxutil/doc/IDocumentSaver.java | 10 ++++----
.../java/fxutil/doc/IDocumentStorage.java | 18 +++++++-------
.../fxutil/doc/IDocumentStorageListener.java | 6 ++---
.../fxutil/doc/SimpleJsonFileStorageImpl.java | 6 ++---
.../src/main/java/simpleex/core/LatLong.java | 6 +++--
.../simpleex/json/LatLongDeserializer.java | 2 +-
.../java/simpleex/json/LatLongSerializer.java | 2 +-
.../simpleex/json/LatLongsDeserializer.java | 6 ++---
.../simpleex/json/LatLongsSerializer.java | 2 +-
.../java/simpleex/ui/FxAppController.java | 4 ++--
.../main/java/simpleex/ui/LatLongsApp.java | 10 ++++----
.../java/simpleex/ui/LatLongsStorage.java | 2 +-
.../java/simpleex/json/AbstractJsonTest.java | 4 ++--
.../java/simpleex/json/LatLongJsonTest.java | 2 +-
.../java/simpleex/json/LatLongsJsonTest.java | 4 ++--
.../src/test/java/simpleex/ui/FxAppTest.java | 4 ++--
20 files changed, 77 insertions(+), 75 deletions(-)
diff --git a/simpleexample/src/main/java/fxutil/doc/AbstractDocumentStorageImpl.java b/simpleexample/src/main/java/fxutil/doc/AbstractDocumentStorageImpl.java
index 95def60..94fa81a 100644
--- a/simpleexample/src/main/java/fxutil/doc/AbstractDocumentStorageImpl.java
+++ b/simpleexample/src/main/java/fxutil/doc/AbstractDocumentStorageImpl.java
@@ -13,14 +13,14 @@ import java.util.Collection;
* Incomplete implementation of **IDocumentStorage**, to simplify implementing ones for specific
* document and location types. The main missing methods are for getting and setting the current
* document, creating an empty one and creating an **InputStream** from a location.
- *
+ *
* @author hal
*
* @param <D> the document type
* @param <L> the location type
*/
public abstract class AbstractDocumentStorageImpl<D, L>
- implements IDocumentStorage<L>, IDocumentPersistence<D, L> {
+implements IDocumentStorage<L>, IDocumentPersistence<D, L> {
private L documentLocation = null;
@@ -43,14 +43,14 @@ public abstract class AbstractDocumentStorageImpl<D, L>
/**
* Returns the current document.
- *
+ *
* @return the current document
*/
protected abstract D getDocument();
/**
- * Sets the current document
- *
+ * Sets the current document.
+ *
* @param document the new document
*/
protected abstract void setDocument(D document);
@@ -88,7 +88,7 @@ public abstract class AbstractDocumentStorageImpl<D, L>
/**
* Creates a new and empty document.
- *
+ *
* @return
*/
protected abstract D createDocument();
@@ -99,11 +99,11 @@ public abstract class AbstractDocumentStorageImpl<D, L>
}
/**
- * Creates an ImportStream from a location
- *
- * @param location
- * @return
- * @throws IOException
+ * Creates an InputStream from a location.
+ *
+ * @param location the location
+ * @return the location's InputStream
+ * @throws IOException when the InputStream cannot be created
*/
protected abstract InputStream toInputStream(L location) throws IOException;
diff --git a/simpleexample/src/main/java/fxutil/doc/FileMenuController.java b/simpleexample/src/main/java/fxutil/doc/FileMenuController.java
index 692db2b..afe841c 100644
--- a/simpleexample/src/main/java/fxutil/doc/FileMenuController.java
+++ b/simpleexample/src/main/java/fxutil/doc/FileMenuController.java
@@ -79,15 +79,6 @@ public class FileMenuController {
}
}
- private void showExceptionDialog(final String message) {
- final Alert alert = new Alert(AlertType.ERROR, message, ButtonType.CLOSE);
- alert.showAndWait();
- }
-
- private void showExceptionDialog(final String message, final Exception e) {
- showExceptionDialog(message + ": " + e.getLocalizedMessage());
- }
-
void handleOpenAction(final File selection) {
try {
documentStorage.openDocument(selection);
@@ -97,6 +88,15 @@ public class FileMenuController {
}
}
+ private void showExceptionDialog(final String message) {
+ final Alert alert = new Alert(AlertType.ERROR, message, ButtonType.CLOSE);
+ alert.showAndWait();
+ }
+
+ private void showExceptionDialog(final String message, final Exception e) {
+ showExceptionDialog(message + ": " + e.getLocalizedMessage());
+ }
+
private void showSaveExceptionDialog(final File location, final Exception e) {
showExceptionDialog("Oops, problem saving to " + location, e);
}
@@ -177,7 +177,7 @@ public class FileMenuController {
private TextInputDialog inputDialog;
@FXML
- public void handleURLImportAction() {
+ public void handleUrlImportAction() {
if (inputDialog == null) {
inputDialog = new TextInputDialog();
}
@@ -191,7 +191,7 @@ public class FileMenuController {
break;
}
try {
- if (handleURLImportAction(new URL(result.get()))) {
+ if (handleUrlImportAction(new URL(result.get()))) {
break;
}
inputDialog.setHeaderText("Problems reading it...");
@@ -202,7 +202,7 @@ public class FileMenuController {
}
}
- boolean handleURLImportAction(final URL url) {
+ boolean handleUrlImportAction(final URL url) {
for (final IDocumentImporter importer : documentStorage.getDocumentImporters()) {
try (InputStream input = url.openStream()) {
importer.importDocument(input);
diff --git a/simpleexample/src/main/java/fxutil/doc/IDocumentImporter.java b/simpleexample/src/main/java/fxutil/doc/IDocumentImporter.java
index 9c7a839..1477a39 100644
--- a/simpleexample/src/main/java/fxutil/doc/IDocumentImporter.java
+++ b/simpleexample/src/main/java/fxutil/doc/IDocumentImporter.java
@@ -6,16 +6,16 @@ import java.io.InputStream;
/**
* An interface with a method for importing domain data from a location. The main use is supporting
* an **import** action in a **File** menu.
- *
+ *
* @author hal
*
*/
public interface IDocumentImporter {
/**
* Loads a document from the input stream and sets it as the current document.
- *
- * @param inputStream
- * @throws IOException
+ *
+ * @param inputStream the document to import
+ * @throws IOException when the document cannot imported
*/
public void importDocument(InputStream inputStream) throws IOException;
}
diff --git a/simpleexample/src/main/java/fxutil/doc/IDocumentLoader.java b/simpleexample/src/main/java/fxutil/doc/IDocumentLoader.java
index 5078db2..5862261 100644
--- a/simpleexample/src/main/java/fxutil/doc/IDocumentLoader.java
+++ b/simpleexample/src/main/java/fxutil/doc/IDocumentLoader.java
@@ -6,7 +6,7 @@ import java.io.InputStream;
* An interface with a method for loading and returning a document (domain data container) from an
* InputStream. This allows various ways of loading or importing domain data, with different sources
* and formats.
- *
+ *
* @author hal
*
* @param <D> the document type
@@ -14,10 +14,10 @@ import java.io.InputStream;
public interface IDocumentLoader<D> {
/**
* Loads and returns a new document from an InputStream
- *
- * @param inputStream
- * @return
- * @throws Exception
+ *
+ * @param inputStream the InputStream to load from
+ * @return the loaded document
+ * @throws Exception when the document couldn't be loaded
*/
public D loadDocument(InputStream inputStream) throws Exception;
}
diff --git a/simpleexample/src/main/java/fxutil/doc/IDocumentSaver.java b/simpleexample/src/main/java/fxutil/doc/IDocumentSaver.java
index 2bca45c..9bfa7be 100644
--- a/simpleexample/src/main/java/fxutil/doc/IDocumentSaver.java
+++ b/simpleexample/src/main/java/fxutil/doc/IDocumentSaver.java
@@ -3,7 +3,7 @@ package fxutil.doc;
/**
* An interface with a method for saving a document (domain data container) to a location. This
* allows various ways of saving or exporting domain data, to different locations and formats.
- *
+ *
* @author hal
*
* @param <D> the document type
@@ -12,10 +12,10 @@ package fxutil.doc;
public interface IDocumentSaver<D, L> {
/**
* Saves the provided document to the provided location
- *
- * @param document
- * @param documentLocation
- * @throws Exception
+ *
+ * @param document the document to save
+ * @param documentLocation the location to save to
+ * @throws Exception when the document couldn't be saved
*/
public void saveDocument(D document, L documentLocation) throws Exception;
}
diff --git a/simpleexample/src/main/java/fxutil/doc/IDocumentStorage.java b/simpleexample/src/main/java/fxutil/doc/IDocumentStorage.java
index 3317705..5eecaa0 100644
--- a/simpleexample/src/main/java/fxutil/doc/IDocumentStorage.java
+++ b/simpleexample/src/main/java/fxutil/doc/IDocumentStorage.java
@@ -8,7 +8,7 @@ import java.util.Collection;
* representing the document (domain data container) is implicit in the implementation of this
* interface. The interface includes methods for getting and setting the location and creating,
* opening and saving the (current) document.
- *
+ *
* @author hal
*
* @param <L> The type of the location, typically java.io.File.
@@ -16,30 +16,30 @@ import java.util.Collection;
public interface IDocumentStorage<L> {
/**
* Returns the current location (of the current document).
- *
+ *
* @return the current location
*/
public L getDocumentLocation();
/**
* Sets the current location (of the current document), can be used by a save-as action.
- *
- * @param documentLocation
+ *
+ * @param documentLocation the new document location
*/
public void setDocumentLocation(L documentLocation);
/**
* Adds an IDocumentStorageListener that will be notified when the current location changes.
- *
- * @param documentStorageListener
+ *
+ * @param documentStorageListener the listener to add
*/
public void addDocumentStorageListener(IDocumentStorageListener<L> documentStorageListener);
/**
* Removes an IDocumentStorageListener.
- *
- * @param documentStorageListener
+ *
+ * @param documentStorageListener the listener to remove
*/
public void removeDocumentStorageListener(IDocumentStorageListener<L> documentStorageListener);
@@ -61,7 +61,7 @@ public interface IDocumentStorage<L> {
/**
* Returns the set of IDocumentImporters, can be used by an import action.
- *
+ *
* @return
*/
public Collection<IDocumentImporter> getDocumentImporters();
diff --git a/simpleexample/src/main/java/fxutil/doc/IDocumentStorageListener.java b/simpleexample/src/main/java/fxutil/doc/IDocumentStorageListener.java
index 15d0e6e..c5d3f0f 100644
--- a/simpleexample/src/main/java/fxutil/doc/IDocumentStorageListener.java
+++ b/simpleexample/src/main/java/fxutil/doc/IDocumentStorageListener.java
@@ -3,15 +3,15 @@ package fxutil.doc;
/**
* Listener interface for the (current) location of the (current) document of an IDocumentStorage,
* e.g. when a **save-as** action is performed.
- *
+ *
* @author hal
*
- * @param <L>
+ * @param <L> the document location type
*/
public interface IDocumentStorageListener<L> {
/**
* Notifies that the current document location has changed.
- *
+ *
* @param documentLocation the new document location
* @param oldDocumentLocation the previous document location
*/
diff --git a/simpleexample/src/main/java/fxutil/doc/SimpleJsonFileStorageImpl.java b/simpleexample/src/main/java/fxutil/doc/SimpleJsonFileStorageImpl.java
index 4f2633c..b081765 100644
--- a/simpleexample/src/main/java/fxutil/doc/SimpleJsonFileStorageImpl.java
+++ b/simpleexample/src/main/java/fxutil/doc/SimpleJsonFileStorageImpl.java
@@ -1,16 +1,16 @@
package fxutil.doc;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.module.SimpleModule;
import java.io.File;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Collection;
import java.util.Collections;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.module.SimpleModule;
public abstract class SimpleJsonFileStorageImpl<T> extends AbstractDocumentStorageImpl<T, File>
- implements IDocumentStorage<File> {
+implements IDocumentStorage<File> {
private T document;
diff --git a/simpleexample/src/main/java/simpleex/core/LatLong.java b/simpleexample/src/main/java/simpleex/core/LatLong.java
index d699232..438f188 100644
--- a/simpleexample/src/main/java/simpleex/core/LatLong.java
+++ b/simpleexample/src/main/java/simpleex/core/LatLong.java
@@ -2,7 +2,10 @@ package simpleex.core;
public class LatLong {
- private final double latitude, longitude;
+ public static final String SEPARATOR = ",";
+
+ private final double latitude;
+ private final double longitude;
public LatLong(final double latitude, final double longitude) {
super();
@@ -10,7 +13,6 @@ public class LatLong {
this.longitude = longitude;
}
- public final static String SEPARATOR = ",";
public double getLatitude() {
return latitude;
diff --git a/simpleexample/src/main/java/simpleex/json/LatLongDeserializer.java b/simpleexample/src/main/java/simpleex/json/LatLongDeserializer.java
index f3c48cd..ddf7f3b 100644
--- a/simpleexample/src/main/java/simpleex/json/LatLongDeserializer.java
+++ b/simpleexample/src/main/java/simpleex/json/LatLongDeserializer.java
@@ -1,6 +1,5 @@
package simpleex.json;
-import java.io.IOException;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
@@ -8,6 +7,7 @@ import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
+import java.io.IOException;
import simpleex.core.LatLong;
public class LatLongDeserializer extends JsonDeserializer<LatLong> {
diff --git a/simpleexample/src/main/java/simpleex/json/LatLongSerializer.java b/simpleexample/src/main/java/simpleex/json/LatLongSerializer.java
index 12342fd..59dfeb6 100644
--- a/simpleexample/src/main/java/simpleex/json/LatLongSerializer.java
+++ b/simpleexample/src/main/java/simpleex/json/LatLongSerializer.java
@@ -1,9 +1,9 @@
package simpleex.json;
-import java.io.IOException;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
+import java.io.IOException;
import simpleex.core.LatLong;
public class LatLongSerializer extends JsonSerializer<LatLong> {
diff --git a/simpleexample/src/main/java/simpleex/json/LatLongsDeserializer.java b/simpleexample/src/main/java/simpleex/json/LatLongsDeserializer.java
index 4b2508f..8e14f6b 100644
--- a/simpleexample/src/main/java/simpleex/json/LatLongsDeserializer.java
+++ b/simpleexample/src/main/java/simpleex/json/LatLongsDeserializer.java
@@ -1,14 +1,14 @@
package simpleex.json;
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Collection;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ArrayNode;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collection;
import simpleex.core.LatLong;
import simpleex.core.LatLongs;
diff --git a/simpleexample/src/main/java/simpleex/json/LatLongsSerializer.java b/simpleexample/src/main/java/simpleex/json/LatLongsSerializer.java
index 8f5bae8..4812b52 100644
--- a/simpleexample/src/main/java/simpleex/json/LatLongsSerializer.java
+++ b/simpleexample/src/main/java/simpleex/json/LatLongsSerializer.java
@@ -1,9 +1,9 @@
package simpleex.json;
-import java.io.IOException;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
+import java.io.IOException;
import simpleex.core.LatLong;
import simpleex.core.LatLongs;
diff --git a/simpleexample/src/main/java/simpleex/ui/FxAppController.java b/simpleexample/src/main/java/simpleex/ui/FxAppController.java
index 08431b7..9750644 100644
--- a/simpleexample/src/main/java/simpleex/ui/FxAppController.java
+++ b/simpleexample/src/main/java/simpleex/ui/FxAppController.java
@@ -1,7 +1,5 @@
package simpleex.ui;
-import java.io.File;
-import java.util.Optional;
import fxmapcontrol.Location;
import fxmapcontrol.MapBase;
import fxmapcontrol.MapItemsControl;
@@ -9,6 +7,8 @@ import fxmapcontrol.MapNode;
import fxmapcontrol.MapProjection;
import fxutil.doc.FileMenuController;
import fxutil.doc.IDocumentListener;
+import java.io.File;
+import java.util.Optional;
import javafx.collections.FXCollections;
import javafx.fxml.FXML;
import javafx.geometry.Point2D;
diff --git a/simpleexample/src/main/java/simpleex/ui/LatLongsApp.java b/simpleexample/src/main/java/simpleex/ui/LatLongsApp.java
index 53a4a53..df7517b 100644
--- a/simpleexample/src/main/java/simpleex/ui/LatLongsApp.java
+++ b/simpleexample/src/main/java/simpleex/ui/LatLongsApp.java
@@ -1,5 +1,10 @@
package simpleex.ui;
+import fxutil.doc.AbstractDocumentStorageImpl;
+import fxutil.doc.IDocumentImporter;
+import fxutil.doc.IDocumentLoader;
+import fxutil.doc.IDocumentPersistence;
+import fxutil.doc.IDocumentStorage;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
@@ -9,11 +14,6 @@ import java.io.OutputStream;
import java.util.Arrays;
import java.util.Collection;
import java.util.stream.Collectors;
-import fxutil.doc.AbstractDocumentStorageImpl;
-import fxutil.doc.IDocumentImporter;
-import fxutil.doc.IDocumentLoader;
-import fxutil.doc.IDocumentPersistence;
-import fxutil.doc.IDocumentStorage;
import simpleex.core.LatLongs;
public class LatLongsApp {
diff --git a/simpleexample/src/main/java/simpleex/ui/LatLongsStorage.java b/simpleexample/src/main/java/simpleex/ui/LatLongsStorage.java
index de1caf1..ede6de2 100644
--- a/simpleexample/src/main/java/simpleex/ui/LatLongsStorage.java
+++ b/simpleexample/src/main/java/simpleex/ui/LatLongsStorage.java
@@ -1,9 +1,9 @@
package simpleex.ui;
-import java.io.File;
import com.fasterxml.jackson.databind.module.SimpleModule;
import fxutil.doc.IDocumentStorage;
import fxutil.doc.SimpleJsonFileStorageImpl;
+import java.io.File;
import simpleex.core.LatLong;
import simpleex.core.LatLongs;
import simpleex.json.LatLongDeserializer;
diff --git a/simpleexample/src/test/java/simpleex/json/AbstractJsonTest.java b/simpleexample/src/test/java/simpleex/json/AbstractJsonTest.java
index 4aaed01..c6eb616 100644
--- a/simpleexample/src/test/java/simpleex/json/AbstractJsonTest.java
+++ b/simpleexample/src/test/java/simpleex/json/AbstractJsonTest.java
@@ -1,13 +1,13 @@
package simpleex.json;
-import java.io.IOException;
-import org.junit.Assert;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;
+import java.io.IOException;
+import org.junit.Assert;
public abstract class AbstractJsonTest {
diff --git a/simpleexample/src/test/java/simpleex/json/LatLongJsonTest.java b/simpleexample/src/test/java/simpleex/json/LatLongJsonTest.java
index 9edcc39..a3c6d4a 100644
--- a/simpleexample/src/test/java/simpleex/json/LatLongJsonTest.java
+++ b/simpleexample/src/test/java/simpleex/json/LatLongJsonTest.java
@@ -1,9 +1,9 @@
package simpleex.json;
+import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
-import com.fasterxml.jackson.databind.ObjectMapper;
import simpleex.core.LatLong;
public class LatLongJsonTest extends AbstractJsonTest {
diff --git a/simpleexample/src/test/java/simpleex/json/LatLongsJsonTest.java b/simpleexample/src/test/java/simpleex/json/LatLongsJsonTest.java
index 7b097de..37f1479 100644
--- a/simpleexample/src/test/java/simpleex/json/LatLongsJsonTest.java
+++ b/simpleexample/src/test/java/simpleex/json/LatLongsJsonTest.java
@@ -1,10 +1,10 @@
package simpleex.json;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.module.SimpleModule;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.module.SimpleModule;
import simpleex.core.LatLong;
import simpleex.core.LatLongs;
diff --git a/simpleexample/src/test/java/simpleex/ui/FxAppTest.java b/simpleexample/src/test/java/simpleex/ui/FxAppTest.java
index 1be05ec..02cd11b 100644
--- a/simpleexample/src/test/java/simpleex/ui/FxAppTest.java
+++ b/simpleexample/src/test/java/simpleex/ui/FxAppTest.java
@@ -3,14 +3,14 @@ package simpleex.ui;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
+import fxmapcontrol.Location;
+import fxmapcontrol.MapBase;
import java.util.ArrayList;
import java.util.List;
import org.junit.Assert;
import org.junit.BeforeClass;
import org.junit.Test;
import org.testfx.framework.junit.ApplicationTest;
-import fxmapcontrol.Location;
-import fxmapcontrol.MapBase;
import javafx.fxml.FXMLLoader;
import javafx.scene.Parent;
import javafx.scene.Scene;
--
GitLab