Changeset 12470 in josm


Ignore:
Timestamp:
2017-07-12T23:47:15+02:00 (2 months ago)
Author:
bastiK
Message:

see #14794 - javadoc

Location:
trunk/src/org/openstreetmap/josm/io
Files:
11 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/io/ChangesetQuery.java

    r11878 r12470  
    2323import org.openstreetmap.josm.tools.date.DateUtils;
    2424
     25/**
     26 * Data class to collect restrictions (parameters) for downloading changesets from the
     27 * OSM API.
     28 * <p>
     29 * @see <a href="https://wiki.openstreetmap.org/wiki/API_v0.6#Query:_GET_.2Fapi.2F0.6.2Fchangesets">OSM API 0.6 call "/changesets?"</a>
     30 */
    2531public class ChangesetQuery {
    2632
  • trunk/src/org/openstreetmap/josm/io/DiffResultProcessor.java

    r11553 r12470  
    3434import org.xml.sax.helpers.DefaultHandler;
    3535
     36/**
     37 * Helper class to process the OSM API server response to a "diff" upload.
     38 * <p>
     39 * New primitives (uploaded with negative id) will be assigned a positive id, etc.
     40 * The goal is to have a clean state, just like a fresh download (assuming no
     41 * concurrent uploads by other users have happened in the meantime).
     42 * <p>
     43 * @see <a href="https://wiki.openstreetmap.org/wiki/API_v0.6#Response_10">API 0.6 diff upload response</a>
     44 */
    3645public class DiffResultProcessor {
    3746
  • trunk/src/org/openstreetmap/josm/io/FileExporter.java

    r10345 r12470  
    1212import org.openstreetmap.josm.gui.layer.MainLayerManager.ActiveLayerChangeListener;
    1313
     14/**
     15 * Abstract base class for file exporters - IO classes that save layers to a file.
     16 */
    1417public abstract class FileExporter implements ActiveLayerChangeListener {
    1518
     
    2831    }
    2932
     33    /**
     34     * Check if this exporter can export a certain layer to a certain file.
     35     *
     36     * Most exporters support just a single layer type.
     37     * @param pathname the target file name (check file extension using the {@link #filter}
     38     * @param layer the layer requested for export
     39     * @return true, if the exporter can handle the layer and filename is okay
     40     */
    3041    public boolean acceptFile(File pathname, Layer layer) {
    3142        return filter.acceptName(pathname.getName());
    3243    }
    3344
     45    /**
     46     * Execute the data export. (To be overridden by subclasses.)
     47     *
     48     * @param file target file
     49     * @param layer the layer to export
     50     * @throws IOException in case of an IO error
     51     */
    3452    public void exportData(File file, Layer layer) throws IOException {
    3553        throw new IOException(tr("Could not export ''{0}''.", file.getName()));
  • trunk/src/org/openstreetmap/josm/io/MissingOAuthAccessTokenException.java

    r9079 r12470  
    22package org.openstreetmap.josm.io;
    33
     4/**
     5 * Exception thrown when a valid OAuth access token was expected, but not found.
     6 */
    47public class MissingOAuthAccessTokenException extends OsmTransferException {
    58
     
    1215
    1316    /**
    14      * Constructs a new {@code OsmTransferException} with the specified detail message and cause.
     17     * Constructs a new {@code MissingOAuthAccessTokenException} with the specified detail message and cause.
    1518     * @param message The detail message (which is saved for later retrieval by the {@link #getMessage} method)
    1619     * @param cause   The cause (which is saved for later retrieval by the {@link #getCause} method).
     
    2225
    2326    /**
    24      * Constructs a new {@code OsmTransferException} with the specified detail message.
     27     * Constructs a new {@code MissingOAuthAccessTokenException} with the specified detail message.
    2528     * @param message The detail message (which is saved for later retrieval by the {@link #getMessage} method)
    2629     */
     
    3033
    3134    /**
    32      * Constructs a new {@code OsmTransferException} with the specified cause.
     35     * Constructs a new {@code MissingOAuthAccessTokenException} with the specified cause.
    3336     * @param cause   The cause (which is saved for later retrieval by the {@link #getCause} method).
    3437     *                A null value is permitted, and indicates that the cause is nonexistent or unknown.
  • trunk/src/org/openstreetmap/josm/io/OsmChangeImporter.java

    r10615 r12470  
    1818import org.openstreetmap.josm.gui.util.GuiHelper;
    1919
     20/**
     21 * File importer that reads OSM change files (*.osc).
     22 * @see <a href="http://wiki.openstreetmap.org/wiki/OsmChange">OsmChange</a>
     23 */
    2024public class OsmChangeImporter extends FileImporter {
    2125
  • trunk/src/org/openstreetmap/josm/io/OsmConnection.java

    r11544 r12470  
    8585     * @param connection the connection
    8686     *
    87      * @throws OsmTransferException if there is currently no OAuth Access Token configured
     87     * @throws MissingOAuthAccessTokenException if there is currently no OAuth Access Token configured
    8888     * @throws OsmTransferException if signing fails
    8989     */
  • trunk/src/org/openstreetmap/josm/io/OsmImporter.java

    r10615 r12470  
    1919import org.openstreetmap.josm.gui.util.GuiHelper;
    2020
     21/**
     22 * File importer that reads *.osm data files. (main storage format for OSM data
     23 * in JOSM)
     24 */
    2125public class OsmImporter extends FileImporter {
    2226
  • trunk/src/org/openstreetmap/josm/io/OsmServerReadPostprocessor.java

    r10600 r12470  
    55import org.openstreetmap.josm.gui.progress.ProgressMonitor;
    66
     7/**
     8 * Interface for plugins to process osm data after it has been downloaded or read
     9 * from file.
     10 * @see OsmReader#registerPostprocessor(OsmServerReadPostprocessor)
     11 */
    712@FunctionalInterface
    813public interface OsmServerReadPostprocessor {
    9 
     14    /**
     15     * Execute the post processor.
     16     * @param ds the dataset to read or modify
     17     * @param progress the progress monitor
     18     */
    1019    void postprocessDataSet(DataSet ds, ProgressMonitor progress);
    1120}
  • trunk/src/org/openstreetmap/josm/io/OsmServerUserInfoReader.java

    r10404 r12470  
    2727import org.xml.sax.SAXException;
    2828
     29/**
     30 * Download and parse info of the logged in user (OSM API v0.6 "/user/details").
     31 * @see <a href="https://wiki.openstreetmap.org/wiki/API_v0.6#Details_of_the_logged-in_user">/user/details</a>
     32 */
    2933public class OsmServerUserInfoReader extends OsmServerReader {
    3034
  • trunk/src/org/openstreetmap/josm/io/OsmServerWritePostprocessor.java

    r10600 r12470  
    77import org.openstreetmap.josm.gui.progress.ProgressMonitor;
    88
     9/**
     10 * Interface for plugins to process osm data after it has been uploaded to the
     11 * OSM server.
     12 * @see OsmServerWriter#registerPostprocessor(OsmServerWritePostprocessor)
     13 */
    914@FunctionalInterface
    1015public interface OsmServerWritePostprocessor {
  • trunk/src/org/openstreetmap/josm/io/StreamProgressUpdater.java

    r11553 r12470  
    99import org.openstreetmap.josm.tools.Utils;
    1010
     11/**
     12 * Helper class for {@link StreamProgressUpdater} to encapsulate interaction with
     13 * the {@link ProgressMonitor}.
     14 */
    1115final class StreamProgressUpdater {
    1216
Note: See TracChangeset for help on using the changeset viewer.