aboutsummaryrefslogtreecommitdiffstats
path: root/main/src/cgeo/geocaching/export/Export.java
diff options
context:
space:
mode:
Diffstat (limited to 'main/src/cgeo/geocaching/export/Export.java')
-rw-r--r--main/src/cgeo/geocaching/export/Export.java16
1 files changed, 16 insertions, 0 deletions
diff --git a/main/src/cgeo/geocaching/export/Export.java b/main/src/cgeo/geocaching/export/Export.java
index 257238c..700c752 100644
--- a/main/src/cgeo/geocaching/export/Export.java
+++ b/main/src/cgeo/geocaching/export/Export.java
@@ -6,8 +6,24 @@ import android.app.Activity;
import java.util.List;
+/**
+ * Represent an exporter to export a {@link List} of {@link cgCache} to various formats.
+ */
public interface Export {
+ /**
+ * Export a {@link List} of {@link cgCache} to various formats.
+ *
+ * @param caches
+ * The {@link List} of {@link cgCache} to be exported
+ * @param activity
+ * optional: Some exporters might have an UI which requires an {@link Activity}
+ */
public void export(List<cgCache> caches, Activity activity);
+ /**
+ * Get the localized name of this exporter.
+ *
+ * @return localized name
+ */
public String getName();
}