Changeset 11367 in josm

Timestamp:

2016-12-08T01:28:57+01:00 (8 years ago)

Author:

Don-vip

Message:

javadoc + diamond operator

Location:

trunk/src/org/openstreetmap/josm/gui

Files:

• NavigatableComponent.java (modified) (17 diffs)
• preferences/SourceEditor.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java

@@ -83 +83 @@
     }
 
+    /**
+     * To determine if a primitive is currently selectable.
+     */
     public transient Predicate<OsmPrimitive> isSelectablePredicate = prim -> {
         if (!prim.isSelectable()) return false;
@@ -94 +97 @@
     };
 
+    /** Snap distance */
     public static final IntegerProperty PROP_SNAP_DISTANCE = new IntegerProperty("mappaint.node.snap-distance", 10);
+    /** Zoom steps to get double scale */
     public static final DoubleProperty PROP_ZOOM_RATIO = new DoubleProperty("zoom.ratio", 2.0);
+    /** Divide intervals between native resolution levels to smaller steps if they are much larger than zoom ratio */
     public static final BooleanProperty PROP_ZOOM_INTERMEDIATE_STEPS = new BooleanProperty("zoom.intermediate-steps", true);
 
+    /** Property name for center change events */
     public static final String PROPNAME_CENTER = "center";
+    /** Property name for scale change events */
     public static final String PROPNAME_SCALE = "scale";
 
@@ -422 +430 @@
     }
 
+    /**
+     * Determines the projection bounds of view area.
+     * @return the projection bounds of view area
+     */
     public ProjectionBounds getProjectionBounds() {
         return getState().getViewArea().getProjectionBounds();
@@ -439 +451 @@
 
     /**
+     * Returns unprojected geographic coordinates for a specific pixel position on the screen.
      * @param x X-Pixelposition to get coordinate from
      * @param y Y-Pixelposition to get coordinate from
      *
-     * @return Geographic unprojected coordinates from a specific pixel coordination
-     *      on the screen.
+     * @return Geographic unprojected coordinates from a specific pixel position on the screen.
      */
     public LatLon getLatLon(int x, int y) {
@@ -449 +461 @@
     }
 
+    /**
+     * Returns unprojected geographic coordinates for a specific pixel position on the screen.
+     * @param x X-Pixelposition to get coordinate from
+     * @param y Y-Pixelposition to get coordinate from
+     *
+     * @return Geographic unprojected coordinates from a specific pixel position on the screen.
+     */
     public LatLon getLatLon(double x, double y) {
         return getLatLon((int) x, (int) y);
     }
 
+    /**
+     * Determines the projection bounds of given rectangle.
+     * @param r rectangle
+     * @return the projection bounds of {@code r}
+     */
     public ProjectionBounds getProjectionBounds(Rectangle r) {
         return getState().getViewArea(r).getProjectionBounds();
@@ -465 +489 @@
     }
 
+    /**
+     * Creates an affine transform that is used to convert the east/north coordinates to view coordinates.
+     * @return The affine transform.
+     */
     public AffineTransform getAffineTransform() {
         return getState().getAffineTransform();
@@ -472 +500 @@
      * Return the point on the screen where this Coordinate would be.
      * @param p The point, where this geopoint would be drawn.
-     * @return The point on screen where "point" would be drawn, relative
-     *      to the own top/left.
+     * @return The point on screen where "point" would be drawn, relative to the own top/left.
      */
     public Point2D getPoint2D(EastNorth p) {
@@ -481 +508 @@
     }
 
+    /**
+     * Return the point on the screen where this Coordinate would be.
+     * @param latlon The point, where this geopoint would be drawn.
+     * @return The point on screen where "point" would be drawn, relative to the own top/left.
+     */
     public Point2D getPoint2D(LatLon latlon) {
         if (latlon == null)
@@ -490 +522 @@
     }
 
+    /**
+     * Return the point on the screen where this Node would be.
+     * @param n The node, where this geopoint would be drawn.
+     * @return The point on screen where "node" would be drawn, relative to the own top/left.
+     */
     public Point2D getPoint2D(Node n) {
         return getPoint2D(n.getEastNorth());
@@ -626 +663 @@
     }
 
+    /**
+     * Zoom to given east/north.
+     * @param newCenter new center coordinates
+     */
     public void zoomTo(EastNorth newCenter) {
         zoomTo(newCenter, getScale());
     }
 
+    /**
+     * Zoom to given lat/lon.
+     * @param newCenter new center coordinates
+     */
     public void zoomTo(LatLon newCenter) {
         zoomTo(Projections.project(newCenter));
@@ -688 +733 @@
     }
 
+    /**
+     * Zoom to given projection bounds.
+     * @param box new projection bounds
+     */
     public void zoomTo(ProjectionBounds box) {
         // -20 to leave some border
@@ -707 +756 @@
     }
 
+    /**
+     * Zoom to given bounds.
+     * @param box new bounds
+     */
     public void zoomTo(Bounds box) {
         zoomTo(new ProjectionBounds(getProjection().latlon2eastNorth(box.getMin()),
@@ -712 +765 @@
     }
 
+    /**
+     * Zoom to given viewport data.
+     * @param viewport new viewport data
+     */
     public void zoomTo(ViewportData viewport) {
         if (viewport == null) return;
@@ -775 +832 @@
     }
 
+    /**
+     * Zoom to previous location.
+     */
     public void zoomPrevious() {
         if (!zoomUndoBuffer.isEmpty()) {
@@ -783 +843 @@
     }
 
+    /**
+     * Zoom to next location.
+     */
     public void zoomNext() {
         if (!zoomRedoBuffer.isEmpty()) {
@@ -791 +854 @@
     }
 
+    /**
+     * Determines if zoom history contains "undo" entries.
+     * @return {@code true} if zoom history contains "undo" entries
+     */
     public boolean hasZoomUndoEntries() {
         return !zoomUndoBuffer.isEmpty();
     }
 
+    /**
+     * Determines if zoom history contains "redo" entries.
+     * @return {@code true} if zoom history contains "redo" entries
+     */
     public boolean hasZoomRedoEntries() {
         return !zoomRedoBuffer.isEmpty();
@@ -1314 +1385 @@
         if (osm != null) {
             if (osm instanceof Node) {
-                nearestList = new ArrayList<OsmPrimitive>(getNearestNodes(p, predicate));
+                nearestList = new ArrayList<>(getNearestNodes(p, predicate));
             } else if (osm instanceof Way) {
-                nearestList = new ArrayList<OsmPrimitive>(getNearestWays(p, predicate));
+                nearestList = new ArrayList<>(getNearestWays(p, predicate));
             }
             if (ignore != null) {

trunk/src/org/openstreetmap/josm/gui/preferences/SourceEditor.java

@@ -98 +98 @@
 import org.xml.sax.SAXException;
 
+/**
+ * Editor for JOSM extensions source entries.
+ * @since 1743
+ */
 public abstract class SourceEditor extends JPanel {
 
@@ -717 +721 @@
     }
 
+    /**
+     * Source entry with additional metadata.
+     */
     public static class ExtendedSourceEntry extends SourceEntry implements Comparable<ExtendedSourceEntry> {
         /** file name used for display */
@@ -1642 +1649 @@
     }
 
+    /**
+     * Helper class for specialized extensions preferences.
+     */
     public abstract static class SourcePrefHelper {
 
@@ -1682 +1692 @@
             Collection<Map<String, String>> src = Main.pref.getListOfStructs(pref, (Collection<Map<String, String>>) null);
             if (src == null)
-                return new ArrayList<SourceEntry>(getDefault());
+                return new ArrayList<>(getDefault());
 
             List<SourceEntry> entries = new ArrayList<>();