#2824: comment removal of caches after GPX import

2 files changed, 50 insertions, 50 deletions

diff --git a/main/src/cgeo/geocaching/files/GPXImporter.java b/main/src/cgeo/geocaching/files/GPXImporter.java
index 10d791b..34c4d02 100644
--- a/main/src/cgeo/geocaching/files/GPXImporter.java
+++ b/main/src/cgeo/geocaching/files/GPXImporter.java
@@ -57,12 +57,12 @@ public class GPXImporter {
     private static final List<String> GPX_MIME_TYPES = Arrays.asList("text/xml", "application/xml");
     private static final List<String> ZIP_MIME_TYPES = Arrays.asList("application/zip", "application/x-compressed", "application/x-zip-compressed", "application/x-zip", "application/octet-stream");
 
-    private Progress progress = new Progress(true);
+    private final Progress progress = new Progress(true);
 
-    private Resources res;
-    private int listId;
-    private IAbstractActivity fromActivity;
-    private Handler importFinishedHandler;
+    private final Resources res;
+    private final int listId;
+    private final IAbstractActivity fromActivity;
+    private final Handler importFinishedHandler;
 
     public GPXImporter(final IAbstractActivity fromActivity, final int listId, final Handler importFinishedHandler) {
         this.listId = listId;
@@ -143,14 +143,12 @@ public class GPXImporter {
                 final Collection<Geocache> caches = doImport();
                 Log.i("Imported successfully " + caches.size() + " caches.");
 
-                final SearchResult search = new SearchResult();
-                for (Geocache cache : caches) {
-                    search.addAndPutInCache(cache);
-                }
+                final SearchResult search = new SearchResult(caches);
+                // Do not put imported caches into the cachecache. That would consume lots of memory for no benefit.
 
                 if (Settings.isStoreOfflineMaps() || Settings.isStoreOfflineWpMaps()) {
                     importStepHandler.sendMessage(importStepHandler.obtainMessage(IMPORT_STEP_STORE_STATIC_MAPS, R.string.gpx_import_store_static_maps, search.getCount()));
-                    boolean finishedWithoutCancel = importStaticMaps(search);
+                    final boolean finishedWithoutCancel = importStaticMaps(search);
                     // Skip last message if static maps where canceled
                     if (!finishedWithoutCancel) {
                         return;
@@ -158,16 +156,16 @@ public class GPXImporter {
                 }
 
                 importStepHandler.sendMessage(importStepHandler.obtainMessage(IMPORT_STEP_FINISHED, search.getCount(), 0, search));
-            } catch (IOException e) {
+            } catch (final IOException e) {
                 Log.i("Importing caches failed - error reading data: ", e);
                 importStepHandler.sendMessage(importStepHandler.obtainMessage(IMPORT_STEP_FINISHED_WITH_ERROR, R.string.gpx_import_error_io, 0, e.getLocalizedMessage()));
-            } catch (ParserException e) {
+            } catch (final ParserException e) {
                 Log.i("Importing caches failed - data format error", e);
                 importStepHandler.sendMessage(importStepHandler.obtainMessage(IMPORT_STEP_FINISHED_WITH_ERROR, R.string.gpx_import_error_parser, 0, e.getLocalizedMessage()));
-            } catch (CancellationException e) {
+            } catch (final CancellationException e) {
                 Log.i("Importing caches canceled");
                 importStepHandler.sendMessage(importStepHandler.obtainMessage(IMPORT_STEP_CANCELED));
-            } catch (Exception e) {
+            } catch (final Exception e) {
                 Log.e("Importing caches failed - unknown error: ", e);
                 importStepHandler.sendMessage(importStepHandler.obtainMessage(IMPORT_STEP_FINISHED_WITH_ERROR, R.string.gpx_import_error_unexpected, 0, e.getLocalizedMessage()));
             }
@@ -207,14 +205,14 @@ public class GPXImporter {
         protected Collection<Geocache> doImport() throws IOException, ParserException {
             Log.i("Import LOC file: " + file.getAbsolutePath());
             importStepHandler.sendMessage(importStepHandler.obtainMessage(IMPORT_STEP_READ_FILE, R.string.gpx_import_loading_caches, (int) file.length()));
-            LocParser parser = new LocParser(listId);
+            final LocParser parser = new LocParser(listId);
             return parser.parse(file, progressHandler);
         }
     }
 
     static class ImportLocAttachmentThread extends ImportThread {
         private final Uri uri;
-        private ContentResolver contentResolver;
+        private final ContentResolver contentResolver;
 
         public ImportLocAttachmentThread(Uri uri, ContentResolver contentResolver, int listId, Handler importStepHandler, CancellableHandler progressHandler) {
             super(listId, importStepHandler, progressHandler);
@@ -226,8 +224,8 @@ public class GPXImporter {
         protected Collection<Geocache> doImport() throws IOException, ParserException {
             Log.i("Import LOC from uri: " + uri);
             importStepHandler.sendMessage(importStepHandler.obtainMessage(IMPORT_STEP_READ_FILE, R.string.gpx_import_loading_caches, -1));
-            InputStream is = contentResolver.openInputStream(uri);
-            LocParser parser = new LocParser(listId);
+            final InputStream is = contentResolver.openInputStream(uri);
+            final LocParser parser = new LocParser(listId);
             try {
                 return parser.parse(is, progressHandler);
             } finally {
@@ -247,7 +245,7 @@ public class GPXImporter {
             try {
                 // try to parse cache file as GPX 10
                 return doImport(new GPX10Parser(listId));
-            } catch (ParserException pe) {
+            } catch (final ParserException pe) {
                 // didn't work -> lets try GPX11
                 return doImport(new GPX11Parser(listId));
             }
@@ -285,7 +283,7 @@ public class GPXImporter {
 
     static class ImportGpxAttachmentThread extends ImportGpxThread {
         private final Uri uri;
-        private ContentResolver contentResolver;
+        private final ContentResolver contentResolver;
 
         public ImportGpxAttachmentThread(Uri uri, ContentResolver contentResolver, int listId, Handler importStepHandler, CancellableHandler progressHandler) {
             super(listId, importStepHandler, progressHandler);
@@ -297,7 +295,7 @@ public class GPXImporter {
         protected Collection<Geocache> doImport(GPXParser parser) throws IOException, ParserException {
             Log.i("Import GPX from uri: " + uri);
             importStepHandler.sendMessage(importStepHandler.obtainMessage(IMPORT_STEP_READ_FILE, R.string.gpx_import_loading_caches, -1));
-            InputStream is = contentResolver.openInputStream(uri);
+            final InputStream is = contentResolver.openInputStream(uri);
             try {
                 return parser.parse(is, progressHandler);
             } finally {
@@ -371,7 +369,7 @@ public class GPXImporter {
 
     static class ImportGpxZipAttachmentThread extends ImportGpxZipThread {
         private final Uri uri;
-        private ContentResolver contentResolver;
+        private final ContentResolver contentResolver;
 
         public ImportGpxZipAttachmentThread(Uri uri, ContentResolver contentResolver, int listId, Handler importStepHandler, CancellableHandler progressHandler) {
             super(listId, importStepHandler, progressHandler);
@@ -394,13 +392,13 @@ public class GPXImporter {
     };
 
     final private Handler importStepHandler = new Handler() {
-        private boolean showProgressAfterCancel = false;
+        private final boolean showProgressAfterCancel = false;
 
         @Override
         public void handleMessage(Message msg) {
             switch (msg.what) {
                 case IMPORT_STEP_START:
-                    Message cancelMessage = importStepHandler.obtainMessage(IMPORT_STEP_CANCEL);
+                    final Message cancelMessage = importStepHandler.obtainMessage(IMPORT_STEP_CANCEL);
                     progress.show((Context) fromActivity, res.getString(R.string.gpx_import_title_reading_file), res.getString(R.string.gpx_import_loading_caches), ProgressDialog.STYLE_HORIZONTAL, cancelMessage);
                     break;
 
@@ -412,7 +410,7 @@ public class GPXImporter {
 
                 case IMPORT_STEP_STORE_STATIC_MAPS:
                     progress.dismiss();
-                    Message skipMessage = importStepHandler.obtainMessage(IMPORT_STEP_STATIC_MAPS_SKIPPED, msg.arg2, 0);
+                    final Message skipMessage = importStepHandler.obtainMessage(IMPORT_STEP_STATIC_MAPS_SKIPPED, msg.arg2, 0);
                     progress.show((Context) fromActivity, res.getString(R.string.gpx_import_title_static_maps), res.getString(R.string.gpx_import_store_static_maps), ProgressDialog.STYLE_HORIZONTAL, skipMessage);
                     progress.setMaxProgressAndReset(msg.arg2);
                     break;
@@ -420,7 +418,7 @@ public class GPXImporter {
                 case IMPORT_STEP_STATIC_MAPS_SKIPPED:
                     progress.dismiss();
                     progressHandler.cancel();
-                    StringBuilder bufferSkipped = new StringBuilder(20);
+                    final StringBuilder bufferSkipped = new StringBuilder(20);
                     bufferSkipped.append(res.getString(R.string.gpx_import_static_maps_skipped)).append(", ").append(msg.arg1).append(' ').append(res.getString(R.string.gpx_import_caches_imported));
                     fromActivity.helpDialog(res.getString(R.string.gpx_import_title_caches_imported), bufferSkipped.toString());
                     importFinished();
@@ -444,7 +442,7 @@ public class GPXImporter {
                     break;
 
                 case IMPORT_STEP_CANCELED:
-                    StringBuilder bufferCanceled = new StringBuilder(20);
+                    final StringBuilder bufferCanceled = new StringBuilder(20);
                     bufferCanceled.append(res.getString(R.string.gpx_import_canceled));
                     if (showProgressAfterCancel) {
                         bufferCanceled.append(", ").append(progress.getProgress()).append(' ').append(res.getString(R.string.gpx_import_caches_imported));
@@ -469,13 +467,13 @@ public class GPXImporter {
             return null;
         }
         final String gpxFileName = gpxfile.getName();
-        File dir = gpxfile.getParentFile();
-        String[] filenameList = dir.list();
-        for (String filename : filenameList) {
+        final File dir = gpxfile.getParentFile();
+        final String[] filenameList = dir.list();
+        for (final String filename : filenameList) {
             if (!StringUtils.containsIgnoreCase(filename, WAYPOINTS_FILE_SUFFIX)) {
                 continue;
             }
-            String expectedGpxFileName = StringUtils.substringBeforeLast(filename, WAYPOINTS_FILE_SUFFIX)
+            final String expectedGpxFileName = StringUtils.substringBeforeLast(filename, WAYPOINTS_FILE_SUFFIX)
                     + StringUtils.substringAfterLast(filename, WAYPOINTS_FILE_SUFFIX);
             if (gpxFileName.equals(expectedGpxFileName)) {
                 return filename;
diff --git a/main/src/cgeo/geocaching/files/GPXParser.java b/main/src/cgeo/geocaching/files/GPXParser.java
index 8412207..f5ae381 100644
--- a/main/src/cgeo/geocaching/files/GPXParser.java
+++ b/main/src/cgeo/geocaching/files/GPXParser.java
@@ -206,7 +206,7 @@ public abstract class GPXParser extends FileParser {
             String stringName;
             try {
                 stringName = cgeoapplication.getInstance().getResources().getResourceName(stringId);
-            } catch (NullPointerException e) {
+            } catch (final NullPointerException e) {
                 return null;
             }
             if (stringName == null) {
@@ -272,7 +272,7 @@ public abstract class GPXParser extends FileParser {
                                     Double.valueOf(longitude)));
                         }
                     }
-                } catch (Exception e) {
+                } catch (final Exception e) {
                     Log.w("Failed to parse waypoint's latitude and/or longitude.");
                 }
             }
@@ -313,6 +313,8 @@ public abstract class GPXParser extends FileParser {
                     // finally store the cache in the database
                     result.add(geocode);
                     cgData.saveCache(cache, EnumSet.of(SaveFlag.SAVE_DB));
+
+                    // avoid the cachecache using lots of memory for caches which the user did not actually look at
                     cgData.removeAllFromCache();
                     showProgressMessage(progressHandler, progressStream.getProgress());
                 } else if (StringUtils.isNotBlank(cache.getName())
@@ -361,7 +363,7 @@ public abstract class GPXParser extends FileParser {
             public void end(String body) {
                 try {
                     cache.setHidden(parseDate(body));
-                } catch (Exception e) {
+                } catch (final Exception e) {
                     Log.w("Failed to parse cache date", e);
                 }
             }
@@ -441,7 +443,7 @@ public abstract class GPXParser extends FileParser {
                 }
                 final MatcherWrapper matcherCode = new MatcherWrapper(patternUrlGeocode, url);
                 if (matcherCode.matches()) {
-                    String geocode = matcherCode.group(1);
+                    final String geocode = matcherCode.group(1);
                     cache.setGeocode(geocode);
                 }
             }
@@ -463,7 +465,7 @@ public abstract class GPXParser extends FileParser {
         final Element cacheParent = getCacheParent(waypoint);
 
         // GSAK extensions
-        for (String gsakNamespace : GSAK_NS) {
+        for (final String gsakNamespace : GSAK_NS) {
             final Element gsak = cacheParent.getChild(gsakNamespace, "wptExtension");
             gsak.getChild(gsakNamespace, "Watch").setEndTextElementListener(new EndTextElementListener() {
 
@@ -481,7 +483,7 @@ public abstract class GPXParser extends FileParser {
         }
 
         // 3 different versions of the GC schema
-        for (String nsGC : nsGCList) {
+        for (final String nsGC : nsGCList) {
             // waypoints.cache
             final Element gcCache = cacheParent.getChild(nsGC, "cache");
 
@@ -499,7 +501,7 @@ public abstract class GPXParser extends FileParser {
                         if (attrs.getIndex("available") > -1) {
                             cache.setDisabled(!attrs.getValue("available").equalsIgnoreCase("true"));
                         }
-                    } catch (Exception e) {
+                    } catch (final Exception e) {
                         Log.w("Failed to parse cache attributes.");
                     }
                 }
@@ -568,14 +570,14 @@ public abstract class GPXParser extends FileParser {
                 public void start(Attributes attrs) {
                     try {
                         if (attrs.getIndex("id") > -1 && attrs.getIndex("inc") > -1) {
-                            int attributeId = Integer.parseInt(attrs.getValue("id"));
-                            boolean attributeActive = Integer.parseInt(attrs.getValue("inc")) != 0;
-                            String internalId = CacheAttributeTranslator.getInternalId(attributeId, attributeActive);
+                            final int attributeId = Integer.parseInt(attrs.getValue("id"));
+                            final boolean attributeActive = Integer.parseInt(attrs.getValue("inc")) != 0;
+                            final String internalId = CacheAttributeTranslator.getInternalId(attributeId, attributeActive);
                             if (internalId != null) {
                                 cache.getAttributes().add(internalId);
                             }
                         }
-                    } catch (NumberFormatException e) {
+                    } catch (final NumberFormatException e) {
                         // nothing
                     }
                 }
@@ -588,7 +590,7 @@ public abstract class GPXParser extends FileParser {
                 public void end(String body) {
                     try {
                         cache.setDifficulty(Float.parseFloat(body));
-                    } catch (NumberFormatException e) {
+                    } catch (final NumberFormatException e) {
                         Log.w("Failed to parse difficulty", e);
                     }
                 }
@@ -601,7 +603,7 @@ public abstract class GPXParser extends FileParser {
                 public void end(String body) {
                     try {
                         cache.setTerrain(Float.parseFloat(body));
-                    } catch (NumberFormatException e) {
+                    } catch (final NumberFormatException e) {
                         Log.w("Failed to parse terrain", e);
                     }
                 }
@@ -625,7 +627,7 @@ public abstract class GPXParser extends FileParser {
 
                 @Override
                 public void end(String state) {
-                    String trimmedState = state.trim();
+                    final String trimmedState = state.trim();
                     if (StringUtils.isNotEmpty(trimmedState)) { // state can be completely empty
                         if (StringUtils.isBlank(cache.getLocation())) {
                             cache.setLocation(validate(state));
@@ -678,7 +680,7 @@ public abstract class GPXParser extends FileParser {
                         if (attrs.getIndex("ref") > -1) {
                             trackable.setGeocode(attrs.getValue("ref"));
                         }
-                    } catch (Exception e) {
+                    } catch (final Exception e) {
                         // nothing
                     }
                 }
@@ -722,7 +724,7 @@ public abstract class GPXParser extends FileParser {
                         if (attrs.getIndex("id") > -1) {
                             log.id = Integer.parseInt(attrs.getValue("id"));
                         }
-                    } catch (Exception e) {
+                    } catch (final Exception e) {
                         // nothing
                     }
                 }
@@ -745,7 +747,7 @@ public abstract class GPXParser extends FileParser {
                 public void end(String body) {
                     try {
                         log.date = parseDate(body).getTime();
-                    } catch (Exception e) {
+                    } catch (final Exception e) {
                         Log.w("Failed to parse log date", e);
                     }
                 }
@@ -784,7 +786,7 @@ public abstract class GPXParser extends FileParser {
             progressStream = new ProgressInputStream(stream);
             Xml.parse(progressStream, Xml.Encoding.UTF_8, root.getContentHandler());
             return cgData.loadCaches(result, EnumSet.of(LoadFlag.LOAD_DB_MINIMAL));
-        } catch (SAXException e) {
+        } catch (final SAXException e) {
             Log.w("Cannot parse .gpx file as GPX " + version + ": could not parse XML - ", e);
             throw new ParserException("Cannot parse .gpx file as GPX " + version + ": could not parse XML", e);
         }
@@ -831,7 +833,7 @@ public abstract class GPXParser extends FileParser {
             return WaypointType.FINAL;
         }
         // this is not fully correct, but lets also look for localized waypoint types
-        for (WaypointType waypointType : WaypointType.ALL_TYPES_EXCEPT_OWN_AND_ORIGINAL) {
+        for (final WaypointType waypointType : WaypointType.ALL_TYPES_EXCEPT_OWN_AND_ORIGINAL) {
             final String localized = waypointType.getL10n();
             if (StringUtils.isNotEmpty(localized)) {
                 if (localized.equalsIgnoreCase(sym)) {