Changeset 36120 in osm

Timestamp:

2023-08-15T18:00:16+02:00 (17 months ago)

Author:

stoecker

Message:

code cleanup

Location:

applications/editors/josm/plugins/livegps

Files:

• build.xml (modified) (1 diff)
• src/livegps/LiveGpsAcquirer.java (modified) (4 diffs)
• src/livegps/LiveGpsAcquirerNMEA.java (modified) (2 diffs)
• src/livegps/LiveGpsData.java (modified) (5 diffs)
• src/livegps/LiveGpsDialog.java (modified) (1 diff)
• src/livegps/LiveGpsDrawHelper.java (modified) (1 diff)
• src/livegps/LiveGpsLayer.java (modified) (1 diff)
• src/livegps/LiveGpsPlugin.java (modified) (1 diff)
• src/livegps/SingleSegmentGpxTrack.java (modified) (1 diff)

applications/editors/josm/plugins/livegps/build.xml

@@ -17 +17 @@
     <import file="../build-common.xml"/>
 
+    <target name="checkstyle" depends="checkstyle-compile">
+        <taskdef resource="com/puppycrawl/tools/checkstyle/ant/checkstyle-ant-task.properties">
+            <classpath refid="checkstyle.classpath"/>
+            <classpath path="${checkstyle-build.dir}"/>
+        </taskdef>
+        <checkstyle config="checkstyle-config.xml">
+            <fileset dir="${basedir}/src" includes="**/*.java" />
+            <formatter type="xml" toFile="checkstyle-josm-${ant.project.name}.xml"/>
+        </checkstyle>
+    </target>
+
 </project>

applications/editors/josm/plugins/livegps/src/livegps/LiveGpsAcquirer.java

@@ -24 +24 @@
 import org.openstreetmap.josm.tools.Logging;
 
+/**
+ * Acquires NMEA data from a GPSD
+ */
 public class LiveGpsAcquirer implements Runnable {
     private String gpsdHost;
@@ -153 +156 @@
 
                 if (JSONProtocol == true)
-                    gpsData = ParseJSON(line);
+                    gpsData = parseJSON(line);
                 else
-                    gpsData = ParseOld(line);
+                    gpsData = parseOld(line);
 
                 if (gpsData == null)
@@ -278 +281 @@
     }
 
-    private LiveGpsData ParseJSON(String line) {
+    private LiveGpsData parseJSON(String line) {
         JsonObject report;
         double lat, lon;
@@ -319 +322 @@
     }
 
-    private LiveGpsData ParseOld(String line) {
+    private LiveGpsData parseOld(String line) {
         String[] words;
         double lat = 0;

applications/editors/josm/plugins/livegps/src/livegps/LiveGpsAcquirerNMEA.java

@@ -142 +142 @@
                     int c = serReader.read();
                     if (c == '$') {
-                        Logging.trace("Parsing NMEA: " + sb.toString().replaceAll("[\r\n]",""));
+                        Logging.trace("Parsing NMEA: " + sb.toString().replaceAll("[\r\n]", ""));
                         parser.parseNMEASentence(sb.toString());
                         sb.delete(0, sb.length());
@@ -155 +155 @@
                         Collection<WayPoint> wpts = parser.getAndDropWaypoints();
                         for (WayPoint w : wpts) {
-                            if(w.getInstant() == null)
+                            if (w.getInstant() == null)
                                 continue;
                             if (w.getInstant().equals(lasttime)) {

applications/editors/josm/plugins/livegps/src/livegps/LiveGpsData.java

@@ -4 +4 @@
 import static org.openstreetmap.josm.tools.I18n.tr;
 
-import java.awt.Point;
 import java.text.DecimalFormat;
 
@@ -14 +13 @@
 import org.openstreetmap.josm.data.osm.IWay;
 import org.openstreetmap.josm.data.osm.Node;
-import org.openstreetmap.josm.data.osm.OsmPrimitive;
 import org.openstreetmap.josm.data.osm.Way;
 import org.openstreetmap.josm.data.osm.WaySegment;
 import org.openstreetmap.josm.gui.MainApplication;
-import org.openstreetmap.josm.gui.MapFrame;
 import org.openstreetmap.josm.spi.preferences.Config;
 import org.openstreetmap.josm.tools.Geometry;
@@ -33 +30 @@
     private float epx, epy;
     private String wayString;
-    private WayPoint wp;
+    private WayPoint waypoint;
     private static final DecimalFormat offsetFormat = new DecimalFormat("0.00");
 
@@ -57 +54 @@
      */
     public WayPoint getWaypoint() {
-        return this.wp;
+        return this.waypoint;
     }
 
     /**
      * Set the waypoint to transfer additional data form NMEA input
-     * @param wp waypoint to set
-     */
-    public void setWaypoint(WayPoint wp) {
-        this.wp = wp;
+     * @param waypoint waypoint to set
+     */
+    public void setWaypoint(WayPoint waypoint) {
+        this.waypoint = waypoint;
     }
 
@@ -186 +183 @@
                      protected void decorateNameWithId(StringBuilder name, IPrimitive primitive) {
                      }
+
                      @Override
                      protected void decorateNameWithNodes(StringBuilder name, IWay way) {

applications/editors/josm/plugins/livegps/src/livegps/LiveGpsDialog.java

@@ -140 +140 @@
             public void run() {
                 /* prevent flickering - skip the connecting message when NMEA input is working */
-                if (!(oldStatus.getStatus() == LiveGpsStatus.GpsStatus.CONNECTION_FAILED && status.getStatus() == LiveGpsStatus.GpsStatus.CONNECTING && nmeaStatus.getStatus() == LiveGpsStatus.GpsStatus.CONNECTED))
+                if (!(oldStatus.getStatus() == LiveGpsStatus.GpsStatus.CONNECTION_FAILED
+                && status.getStatus() == LiveGpsStatus.GpsStatus.CONNECTING
+                && nmeaStatus.getStatus() == LiveGpsStatus.GpsStatus.CONNECTED))
                     statusLabel.setText(status.getStatusMessage());
-                if (status.getStatus() != LiveGpsStatus.GpsStatus.CONNECTED && nmeaStatus.getStatus() != LiveGpsStatus.GpsStatus.CONNECTED) {
+                if (status.getStatus() != LiveGpsStatus.GpsStatus.CONNECTED
+                && nmeaStatus.getStatus() != LiveGpsStatus.GpsStatus.CONNECTED) {
                     panel.setBackground(Color.RED);
                 } else {

applications/editors/josm/plugins/livegps/src/livegps/LiveGpsDrawHelper.java

@@ -14 +14 @@
 import org.openstreetmap.josm.spi.preferences.Config;
 
+/**
+ * Painting the LiveGPS data layer, especially the current position arrow
+ */
 public class LiveGpsDrawHelper extends GpxDrawHelper {
     private final LiveGpsLayer layer;

applications/editors/josm/plugins/livegps/src/livegps/LiveGpsLayer.java

@@ -22 +22 @@
 import org.openstreetmap.josm.spi.preferences.Config;
 
+/**
+ * The LiveGPS layer
+ */
 public class LiveGpsLayer extends GpxLayer implements PropertyChangeListener {
     public static final String LAYER_NAME = tr("LiveGPS layer");

applications/editors/josm/plugins/livegps/src/livegps/LiveGpsPlugin.java

@@ -29 +29 @@
 import org.openstreetmap.josm.tools.Shortcut;
 
+/**
+ * Main LiveGPS plugin class
+ */
 public class LiveGpsPlugin extends Plugin implements LayerChangeListener {
     private boolean enabled = false;

applications/editors/josm/plugins/livegps/src/livegps/SingleSegmentGpxTrack.java

@@ -11 +11 @@
 import org.openstreetmap.josm.data.gpx.WithAttributes;
 
+/**
+ * LiveGPS track which gets step by step expanded with new data
+ */
 public class SingleSegmentGpxTrack extends WithAttributes implements IGpxTrack {