Changeset 34223 in osm for applications/editors/josm/plugins/cadastre-fr/src

Timestamp:

2018-05-29T01:26:17+02:00 (7 years ago)

Author:

donvip

Message:

fix some java/javadoc warnings

Location:

applications/editors/josm/plugins/cadastre-fr/src/org/openstreetmap/josm/plugins/fr/cadastre

Files:

• actions/mapmode/Address.java (modified) (3 diffs)
• actions/upload/CheckSourceUploadHook.java (modified) (1 diff)
• download/CadastreDownloadData.java (modified) (1 diff)
• edigeo/EdigeoLotFile.java (modified) (1 diff)
• edigeo/utils/ClassToInstancesMap.java (modified) (3 diffs)
• wms/CacheFileLambert4ZoneFilter.java (modified) (3 diffs)
• wms/CacheFileLambert9ZoneFilter.java (modified) (4 diffs)
• wms/CacheFileUTM20NFilter.java (modified) (4 diffs)
• wms/CadastreGrabber.java (modified) (2 diffs)
• wms/CadastreInterface.java (modified) (11 diffs)
• wms/GrabThread.java (modified) (8 diffs)
• wms/ImageModifier.java (modified) (3 diffs)

applications/editors/josm/plugins/cadastre-fr/src/org/openstreetmap/josm/plugins/fr/cadastre/actions/mapmode/Address.java

@@ -89 +89 @@
     JLabel link = new JLabel();
     private transient Way selectedWay;
-    private boolean shift;
-    private boolean ctrl;
 
     /**
@@ -129 +127 @@
         if (e.getButton() != MouseEvent.BUTTON1)
             return;
-        shift = (e.getModifiers() & ActionEvent.SHIFT_MASK) != 0;
-        ctrl = (e.getModifiers() & ActionEvent.CTRL_MASK) != 0;
+        updateKeyModifiers(e);
         MapView mv = MainApplication.getMap().mapView;
         Point mousePos = e.getPoint();
@@ -379 +376 @@
             // fall through to default action.
             // (for semi-parallel lines, intersection might be miles away!)
-            if (MainApplication.getMap().mapView.getPoint(n).distance(MainApplication.getMap().mapView.getPoint(intersection)) < snapToIntersectionThreshold) {
+            MapView mv = MainApplication.getMap().mapView;
+            if (mv.getPoint(n).distance(mv.getPoint(intersection)) < snapToIntersectionThreshold) {
                 n.setEastNorth(intersection);
                 return;
             }
-
+            // fall through
         default:
             EastNorth P = n.getEastNorth();

applications/editors/josm/plugins/cadastre-fr/src/org/openstreetmap/josm/plugins/fr/cadastre/actions/upload/CheckSourceUploadHook.java

@@ -55 +55 @@
     /**
      * Check whenever one of the keys of the object is "source"
+     * @param osm primitive to check
      * @return true if one of keys is "source"
      */
     private boolean tagSourceExist(OsmPrimitive osm) {
-        for (String key : osm.keySet()) {
-            if (key.equals("source")) {
-                return true;
-            }
-        }
-        return false;
+        return osm.hasKey("source");
     }
 

applications/editors/josm/plugins/cadastre-fr/src/org/openstreetmap/josm/plugins/fr/cadastre/download/CadastreDownloadData.java

@@ -18 +18 @@
     /**
      * Constructs a new {@code CadastreDownloadData}.
+     * @param downloadWater whether to download water layer
+     * @param downloadBuilding whether to download building layer
+     * @param downloadSymbol whether to download symbol layer
+     * @param downloadParcel whether to download parcel layer
+     * @param downloadParcelNumber whether to download parcel number layer
+     * @param downloadAddress whether to download address layer
+     * @param downloadLocality whether to download locality layer
+     * @param downloadSection whether to download section layer
+     * @param downloadCommune whether to download communal layer
      */
     CadastreDownloadData(boolean downloadWater, boolean downloadBuilding, boolean downloadSymbol,

applications/editors/josm/plugins/cadastre-fr/src/org/openstreetmap/josm/plugins/fr/cadastre/edigeo/EdigeoLotFile.java

@@ -77 +77 @@
     /**
      * Finds a descriptor by its identifier.
+     * @param <T> block type
      * @param values 4 values obtained from a {@code EdigeoRecord}:<ol>
      * <li>Lot identifier</li>

applications/editors/josm/plugins/cadastre-fr/src/org/openstreetmap/josm/plugins/fr/cadastre/edigeo/utils/ClassToInstancesMap.java

@@ -20 +20 @@
      * entry for this class is present. This will only return values that were
      * bound to this specific class, not values that may have been bound to a subtype.
+     * @param <T> block type
      * @param type type
      * @return the values the specified class is mapped to, or {@code null}
@@ -28 +29 @@
      * Maps the specified class to the specified values. Does <i>not</i> associate
      * these values with any of the class's supertypes.
+     * @param <T> block type
      * @param type type
      * @param values new values
@@ -38 +40 @@
     /**
      * Adds a new value to the list mapped to the specified class.
+     * @param <T> block type
      * @param type type
      * @param value value to add

applications/editors/josm/plugins/cadastre-fr/src/org/openstreetmap/josm/plugins/fr/cadastre/wms/CacheFileLambert4ZoneFilter.java

@@ -17 +17 @@
     private final String description;
 
+    /**
+     * Filters for each one of the 4 Lambert zones.
+     */
     public static final CacheFileLambert4ZoneFilter[] filters = {
         new CacheFileLambert4ZoneFilter("1", tr("Lambert Zone {0} cache file (.{0})", 1)),
@@ -26 +29 @@
     /**
      * Construct an extension file filter by giving the extension to check after.
-     *
+     * @param extension file extension
+     * @param description file description
      */
     private CacheFileLambert4ZoneFilter(String extension, String description) {
@@ -33 +37 @@
     }
 
-    public boolean acceptName(String filename) {
+    boolean acceptName(String filename) {
         String name = filename.toLowerCase(Locale.FRANCE);
         for (String ext : extension.split(",")) {

applications/editors/josm/plugins/cadastre-fr/src/org/openstreetmap/josm/plugins/fr/cadastre/wms/CacheFileLambert9ZoneFilter.java

@@ -16 +16 @@
     private final String description;
 
+    /**
+     * Filters for each one of the 9 Lambert zones.
+     */
     public static CacheFileLambert9ZoneFilter[] filters = {
         new CacheFileLambert9ZoneFilter("cc1", tr("Lambert CC9 Zone {0} cache file (.CC{0})", 1)),
@@ -30 +33 @@
     /**
      * Construct an extension file filter by giving the extension to check after.
-     *
+     * @param extension file extension
+     * @param description file description
      */
     private CacheFileLambert9ZoneFilter(String extension, String description) {
@@ -37 +41 @@
     }
 
-    public boolean acceptName(String filename) {
+    boolean acceptName(String filename) {
         String name = filename.toLowerCase();
         for (String ext : extension.split(",")) {
@@ -57 +61 @@
         return description;
     }
-
 }

applications/editors/josm/plugins/cadastre-fr/src/org/openstreetmap/josm/plugins/fr/cadastre/wms/CacheFileUTM20NFilter.java

@@ -16 +16 @@
     private final String description;
 
+    /**
+     * Filters for each one of the 4 French UTM zones.
+     */
     public static CacheFileUTM20NFilter[] filters = {
         new CacheFileUTM20NFilter("utm1", tr("Guadeloupe Fort-Marigot cache file (.UTM1)")),
@@ -25 +28 @@
     /**
      * Construct an extension file filter by giving the extension to check after.
-     *
+     * @param extension file extension
+     * @param description file description
      */
     private CacheFileUTM20NFilter(String extension, String description) {
@@ -32 +36 @@
     }
 
-    public boolean acceptName(String filename) {
+    boolean acceptName(String filename) {
         String name = filename.toLowerCase();
         for (String ext : extension.split(",")) {
@@ -52 +56 @@
         return description;
     }
-
 }

applications/editors/josm/plugins/cadastre-fr/src/org/openstreetmap/josm/plugins/fr/cadastre/wms/CadastreGrabber.java

@@ -21 +21 @@
     private CadastreInterface wmsInterface = new CadastreInterface();
 
-    public GeorefImage grab(WMSLayer wmsLayer, EastNorth lambertMin, EastNorth lambertMax)
+    GeorefImage grab(WMSLayer wmsLayer, EastNorth lambertMin, EastNorth lambertMax)
             throws IOException, OsmTransferException {
         try {
@@ -89 +89 @@
     }
 
-    public CadastreInterface getWmsInterface() {
+    CadastreInterface getWmsInterface() {
         return wmsInterface;
     }

applications/editors/josm/plugins/cadastre-fr/src/org/openstreetmap/josm/plugins/fr/cadastre/wms/CadastreInterface.java

@@ -38 +38 @@
 
 public class CadastreInterface {
-    public boolean downloadCanceled;
+    boolean downloadCanceled;
     private Response urlConn;
 
@@ -60 +60 @@
     private long cookieTimestamp;
 
-    public static final String BASE_URL = "https://www.cadastre.gouv.fr";
+    static final String BASE_URL = "https://www.cadastre.gouv.fr";
     static final String C_IMAGE_FORMAT = "Cette commune est au format ";
     static final String C_COMMUNE_LIST_START = "<select name=\"codeCommune\"";
@@ -84 +84 @@
     static final int RETRIES_GET_COOKIE = 10; // 10 times every 3 seconds means 30 seconds trying to get a cookie
 
-    public boolean retrieveInterface(WMSLayer wmsLayer) throws DuplicateLayerException, WMSException {
+    boolean retrieveInterface(WMSLayer wmsLayer) throws DuplicateLayerException, WMSException {
         if (wmsLayer.getName().isEmpty())
             return false;
@@ -120 +120 @@
      * Returns if a cookie is delivered by WMS, throws exception if WMS is not opening a client session
      * (too many clients or in maintenance)
+     * @throws IOException if an I/O error occurs
      */
     private void getCookie() throws IOException {
@@ -174 +175 @@
     }
 
-    public void resetCookie() {
+    void resetCookie() {
         lastWMSLayerName = null;
         cookie = null;
     }
 
-    public boolean isCookieExpired() {
+    boolean isCookieExpired() {
         long now = new Date().getTime();
         if ((now - cookieTimestamp) > COOKIE_EXPIRATION) {
@@ -188 +189 @@
     }
 
-    public void resetInterfaceRefIfNewLayer(String newWMSLayerName) {
+    void resetInterfaceRefIfNewLayer(String newWMSLayerName) {
         if (!newWMSLayerName.equals(lastWMSLayerName)) {
             interfaceRef = null;
@@ -195 +196 @@
     }
 
-    public HttpClient getHttpClient(URL url) {
+    HttpClient getHttpClient(URL url) {
         return HttpClient.create(url).setHeader("Cookie", cookie);
     }
 
-    public HttpClient getHttpClient(URL url, String method) {
+    HttpClient getHttpClient(URL url, String method) {
         return HttpClient.create(url, method).setHeader("Cookie", cookie);
     }
@@ -275 +276 @@
      * The returned string is the interface name used in further requests, e.g. "afficherCarteCommune.do?c=QP224"
      * where QP224 is the code commune known by the WMS (or "afficherCarteTa.do?c=..." for raster images).
+     * @param wmsLayer WMS layer
+     * @param codeCommune Commune code
      *
      * @return retURL url to available code commune in the cadastre; "" if not found
+     * @throws IOException if an I/O error occurs
      */
     private String postForm(WMSLayer wmsLayer, String codeCommune) throws IOException {
@@ -466 +470 @@
      * @throws IOException if any I/O error occurs
      */
-    public void retrieveCommuneBBox(WMSLayer wmsLayer) throws IOException {
+    void retrieveCommuneBBox(WMSLayer wmsLayer) throws IOException {
         if (interfaceRef == null)
             return;
@@ -542 +546 @@
     }
 
-    public void cancel() {
+    void cancel() {
         if (urlConn != null) {
             urlConn.disconnect();
@@ -550 +554 @@
     }
 
-    public InputStream getContent(URL url) throws IOException, OsmTransferException {
+    InputStream getContent(URL url) throws IOException, OsmTransferException {
         urlConn = getHttpClient(url).setHeader("Connection", "close").connect();
         return urlConn.getContent();

applications/editors/josm/plugins/cadastre-fr/src/org/openstreetmap/josm/plugins/fr/cadastre/wms/GrabThread.java

@@ -36 +36 @@
     /**
      * Call directly grabber for raster images or prepare thread for vector images
+     * @param moreImages more images to grab
      */
-    public void addImages(ArrayList<EastNorthBound> moreImages) {
+    void addImages(ArrayList<EastNorthBound> moreImages) {
         lockImagesToGrag.lock();
         imagesToGrab.addAll(moreImages);
@@ -57 +58 @@
     }
 
-    public ArrayList<EastNorthBound> getImagesToGrabCopy() {
+    ArrayList<EastNorthBound> getImagesToGrabCopy() {
         ArrayList<EastNorthBound> copyList = new ArrayList<>();
         lockImagesToGrag.lock();
@@ -68 +69 @@
     }
 
-    public void clearImagesToGrab() {
+    void clearImagesToGrab() {
         lockImagesToGrag.lock();
         imagesToGrab.clear();
@@ -143 +144 @@
     }
 
-    public void saveToCache(GeorefImage image) {
+    void saveToCache(GeorefImage image) {
         if (CacheControl.cacheEnabled && !wmsLayer.isRaster()) {
             getCacheControl().saveCache(image);
@@ -160 +161 @@
     }
 
+    /**
+     * Cancel grab.
+     */
     public void cancel() {
         clearImagesToGrab();
@@ -170 +174 @@
     }
 
+    /**
+     * Returns the Cache control.
+     * @return the Cache control
+     */
     public CacheControl getCacheControl() {
         if (cacheControl == null)
@@ -176 +184 @@
     }
 
-    public GrabThread(WMSLayer wmsLayer) {
+    GrabThread(WMSLayer wmsLayer) {
         this.wmsLayer = wmsLayer;
     }
 
-    public void paintBoxesToGrab(Graphics g, MapView mv) {
+    void paintBoxesToGrab(Graphics g, MapView mv) {
         if (getImagesToGrabSize() > 0) {
             ArrayList<EastNorthBound> imagesToGrab = getImagesToGrabCopy();
@@ -207 +215 @@
     }
 
-    public boolean isCanceled() {
+    boolean isCanceled() {
         return canceled;
     }
 
-    public void setCanceled(boolean canceled) {
+    void setCanceled(boolean canceled) {
         this.canceled = canceled;
     }
 
-    public CadastreGrabber getGrabber() {
+    CadastreGrabber getGrabber() {
         return grabber;
     }
 
-    public void setGrabber(CadastreGrabber grabber) {
+    void setGrabber(CadastreGrabber grabber) {
         this.grabber = grabber;
     }

applications/editors/josm/plugins/cadastre-fr/src/org/openstreetmap/josm/plugins/fr/cadastre/wms/ImageModifier.java

@@ -20 +20 @@
     protected BufferedImage bufferedImage;
 
-    public static int[] cRoofColors = new int[] {-197380, -592138};
-    public static int[] cBuilingFootColors = new int[] {-256};
+    private static int[] cRoofColors = new int[] {-197380, -592138};
+    private static int[] cBuilingFootColors = new int[] {-256};
 
     protected BufferedImage convert1(BufferedImage src) {
@@ -70 +70 @@
         };
         return convert4(src, cmap);
-      }
+    }
 
-      /**
-       * Converts the source image to 4-bit colour
-       * using the given colour map.  No transparency.
-       * @param src the source image to convert
-       * @param cmap the colour map, which should contain no more than 16 entries
-       * The entries are in the form RRGGBB (hex).
-       * @return a copy of the source image with a 4-bit colour depth, with the custom colour pallette
-       */
+    /**
+     * Converts the source image to 4-bit colour
+     * using the given colour map.  No transparency.
+     * @param src the source image to convert
+     * @param cmap the colour map, which should contain no more than 16 entries
+     * The entries are in the form RRGGBB (hex).
+     * @return a copy of the source image with a 4-bit colour depth, with the custom colour pallette
+     */
     protected BufferedImage convert4(BufferedImage src, int[] cmap) {
         IndexColorModel icm = new IndexColorModel(
@@ -156 +156 @@
     /**
      * Checks if the rgb value is the black background color
+     * @param img image
+     * @param x X coordinate
+     * @param y Y coordinate
+     * @return {@code true} if the rgb value is the black background color
      */
     public boolean isBackgroundColor(BufferedImage img, int x, int y) {